id
stringlengths 8
78
| source
stringclasses 743
values | chunk_id
int64 1
5.05k
| text
stringlengths 593
49.7k
|
|---|---|---|---|
storagegateway-vgw-ug-129
|
storagegateway-vgw-ug.pdf
| 129 |
Gateway User Guide. Storage Gateway is now available in the AWS GovCloud (US-East) Region. For more information, see AWS Storage Gateway Endp oints and Quotas in the AWS General Reference. March 12, 2020 New AWS Region API Version 2013-06-30 356 AWS Storage Gateway Volume Gateway User Guide Support for Linux Kernel-ba sed Virtual Machine (KVM) Storage Gateway now provides the ability to deploy February 4, 2020 hypervisor an on-premises gateway on the KVM virtualization platform. Gateways deployed on KVM have all the same functionality and features as the existing on-premises gateways. For more informat ion, see Supported Hy pervisors and Host Requireme nts in the Storage Gateway User Guide. Support for VMware vSphere High Availability Storage Gateway now provides support for high November 20, 2019 availability on VMware to help protect storage workloads against hardware, hypervisor, or network failures. For more informat ion, see Using VMware vSphere High Availability with Storage Gateway in the Storage Gateway User Guide. This release also includes performance improvements. For more information, see Performance in the Storage Gateway User Guide. API Version 2013-06-30 357 AWS Storage Gateway Volume Gateway User Guide New AWS Region for Tape Gateway Tape Gateway is now available in the South September 24, 2019 America (Sao Paulo) Region. For more information, see AWS Storage Gateway Endpoints and Quotas in the AWS General Reference. Support for IBM Spectrum Protect version 7.1.9 on Linux, Tape Gateways now support IBM Spectrum Protect (Tivoli and for Tape Gateways an Storage Manager) vers increased maximum tape size ion 7.1.9 running on Linux, September 10, 2019 to 5 TiB in addition to running on Microsoft Windows. For more information, see Testing Your Setup by Using IBM Spectrum Protect in the Storage Gateway User Guide.. Also, for Tape Gateways, the maximum size of a virtual tape is now increased from 2.5 TiB to 5 TiB. For more information, see Quotas for Tapes in the Storage Gateway User Guide.. API Version 2013-06-30 358 AWS Storage Gateway Volume Gateway User Guide Support for Amazon CloudWatch Logs New AWS Region New AWS Region September 4, 2019 August 14, 2019 July 29, 2019 You can now configure File Gateways with Amazon CloudWatch Log Groups to get notified about errors and the health of your gateway and its resources. For more information, see Getting Noti fied About Gateway Health and Errors With Amazon CloudWatch Log Groups in the Storage Gateway User Guide. Storage Gateway is now available in the Asia Pacific (Hong Kong) Region. For more information, see AWS Storage Gateway Endpoints and Quotas in the AWS General Reference. Storage Gateway is now available in the Middle East (Bahrain) Region. For more information, see AWS Storage Gateway Endpoints and Quotas in the AWS General Reference. API Version 2013-06-30 359 AWS Storage Gateway Volume Gateway User Guide Support for activating a gateway in a virtual private You can now activate a gateway in a VPC. You can June 20, 2019 cloud (VPC) create a private connection between your on-premises software appliance and cloud- based storage infrastructure . For more information, see Activating a Gateway in a V irtual Private Cloud. Support for moving virtual tapes from S3 Glacier Flexible You can now move your virtual tapes that are archived May 28, 2019 Retrieval to S3 Glacier Deep in the S3 Glacier Flexible Archive Retrieval storage class to the S3 Glacier Deep Archive stora ge class for cost effective and long-term data retention . For more information, see Moving a Tape from S3 Glacier Flexible Retrieval to S3 Glacier Deep Archive. SMB file share support for Microsoft Windows ACLs For File Gateways, you can now use Microsoft Windows May 8, 2019 access control lists (ACLs) to control access to Server Message Block (SMB) file shares. For more information, see Using Microsoft Windows ACLs to Control Access to an SMB File Share. API Version 2013-06-30 360 AWS Storage Gateway Volume Gateway User Guide Integration with S3 Glacier Deep Archive Tape Gateway integrates with S3 Glacier Deep Archive. You March 27, 2019 can now archive virtual tapes in S3 Glacier Deep Archive for long-term data retentio n. For more information, see Archiving Virtual Tapes. Availability of Storage Gateway Hardware Appliance The Storage Gateway Hardware Appliance is now February 25, 2019 in Europe Integration with AWS Backup available in Europe. For more information, see AWS Storage Gateway Hardware Appliance Regions in the AWS General Reference. In addition, you can now increase the useable storage on the Storage Gateway Hardware Appliance from 5 TB to 12 TB and replace the installed copper network card with a 10 Gigabit fiber optic network card. For more information, see Setting Up Your Hardware Appliance. Storage Gateway integrate s with AWS Backup. You can now use AWS Backup to back up on-premises business applications that use Storage Gateway volumes for cloud- backed storage.
|
storagegateway-vgw-ug-130
|
storagegateway-vgw-ug.pdf
| 130 |
February 25, 2019 in Europe Integration with AWS Backup available in Europe. For more information, see AWS Storage Gateway Hardware Appliance Regions in the AWS General Reference. In addition, you can now increase the useable storage on the Storage Gateway Hardware Appliance from 5 TB to 12 TB and replace the installed copper network card with a 10 Gigabit fiber optic network card. For more information, see Setting Up Your Hardware Appliance. Storage Gateway integrate s with AWS Backup. You can now use AWS Backup to back up on-premises business applications that use Storage Gateway volumes for cloud- backed storage. For more information, see Backing Up Your Volumes. January 16, 2019 API Version 2013-06-30 361 AWS Storage Gateway Volume Gateway User Guide Support for Bacula Enterprise and IBM Spectrum Protect Tape Gateways now support Bacula Enterprise and IBM November 13, 2018 Spectrum Protect. Storage Gateway also now supports newer versions of Veritas NetBackup, Veritas Backu p Exec and Quest NetVault backup. You can now use these backup applications to back up your data to Amazon S3 and archive directly to offline storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Using Your Backup Software to Test Your Gateway Setup. Support for Storage Gateway Hardware Appliance The Storage Gateway Hardware Appliance includes September 18, 2018 Storage Gateway software preinstalled on a third-party server. You can manage the appliance from the AWS Management Console. The appliance can host file, tape, and Volume Gateways. For more information, see Using the Storage Gateway Hard ware Appliance. API Version 2013-06-30 362 AWS Storage Gateway Volume Gateway User Guide Compatibility with Microsoft System Center 2016 Data Tape Gateways are now compatible with Microsoft Protection Manager (DPM) System Center 2016 Data July 18, 2018 Protection Manager (DPM). You can now use Microsoft DPM to back up your data to Amazon S3 and archive directly to offline storage (S3 Glacier Flexible Retrieval or S 3 Glacier Deep Archive). For more information, see Testing Your Setup by Using Microsoft System Center Data Protectio n Manager. Support for Server Message Block (SMB) protocol File Gateways added support for the Server Message Block June 20, 2018 (SMB) protocol to file shares. For more information, see Creating a File Share. Support for file share, cached volumes, and virtual tape You can now use AWS Key Management Service encryption (AWS KMS) to encrypt data June 12, 2018 written to a file share, cached volume, or virtual tape. Currently, you can do this by using the AWS Storage Gateway API. For more information, see Data encryption using AWS KMS. API Version 2013-06-30 363 AWS Storage Gateway Volume Gateway User Guide Support for NovaStor DataCenter/Network Tape Gateways now support NovaStor DataCenter/ May 24, 2018 Network. You can now use NovaStor DataCente r/Network version 6.4 or 7.1 to back up your data to Amazon S3 and archive directly to offline storage (S3 Glacier Flexible Retrieval or S 3 Glacier Deep Archive). For more information, see Testing Your Setup by Using NovaSt or DataCenter/Network. Earlier updates The following table describes important changes in each release of the AWS Storage Gateway User Guide before May 2018. Change Description Support for S3 One Zone_IA For File Gateways, you can now choose S3 One Zone_IA as the default storage class for your file storage class shares. Using this storage class, you can store your object data in a single Availability Zone in Amazon S3. For more information, see Create a file share. New Region Tape Gateway is now available in the Asia Pacific (Singapore) Region. For detailed information, see AWS Regions that support Storage Gateway. Support for refresh cache notification, requester pays, With File Gateways, you can now be notified when the gateway finishes refreshing the cache for your Amazon S3 bucket. For more information, see RefreshCache.html in the Storage Gateway API Refer and canned ACL ence. Date Changed April 4, 2018 April 3, 2018 March 1, 2018 Earlier updates API Version 2013-06-30 364 AWS Storage Gateway Change Description Volume Gateway User Guide Date Changed s for Amazon S3 File Gateways now allow the requester or reader buckets. instead of the bucket owner to pay for access charges. File Gateways now allow you to give full control to the owner of the S3 bucket that maps to the NFS file share. For more information, see Create a file share. Support for Dell EMC NetWorker V9.x Tape Gateways now support Dell EMC NetWorker V9.x. You can now use Dell EMC NetWorker V9.x to back up your data to Amazon S3 and archive directly February 27, 2018 to offline storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Testing Your Setup by Using Dell EMC NetWorker. New Region Storage Gateway is now available in the Europe (Paris) Region. For detailed information, see
|
storagegateway-vgw-ug-131
|
storagegateway-vgw-ug.pdf
| 131 |
full control to the owner of the S3 bucket that maps to the NFS file share. For more information, see Create a file share. Support for Dell EMC NetWorker V9.x Tape Gateways now support Dell EMC NetWorker V9.x. You can now use Dell EMC NetWorker V9.x to back up your data to Amazon S3 and archive directly February 27, 2018 to offline storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Testing Your Setup by Using Dell EMC NetWorker. New Region Storage Gateway is now available in the Europe (Paris) Region. For detailed information, see AWS December 18, 2017 Regions that support Storage Gateway. Support for file upload notificat File Gateways can now notify you when all files written to your NFS file share have been uploaded November 21, 2017 ion and guessing to Amazon S3. For more information, see NotifyWhe of the MIME type nUploaded in the Storage Gateway API Reference. File Gateways now allow guessing of the MIME type for uploaded objects based on file extensions. For more information, see Create a file share. Support for VMware ESXi Hypervisor version 6.5 AWS Storage Gateway now supports VMware ESXi Hypervisor version 6.5. This is in addition to version 4.1, 5.0, 5.1, 5.5, and 6.0. For more information, see Supported hypervisors and host requirements. September 13, 2017 Earlier updates API Version 2013-06-30 365 AWS Storage Gateway Change Description Volume Gateway User Guide Date Changed Compatibility with Commvault 11 Tape Gateways are now compatible with Commvault 11. You can now use Commvault to back up your September 12, 2017 data to Amazon S3 and archive directly to offline storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Testing Y our Setup by Using Commvault. File Gateway support for You can now deploy a File Gateway on a Microsoft Hyper-V hypervisor. For information, see Supported June 22, 2017 Microsoft Hyper-V hypervisors and host requirements. hypervisor Support for three to five hour tape For a Tape Gateway, you can now retrieve your tapes from archive in three to five hours. You can also May 23, 2017 retrieval from determine the amount of data written to your tape archive from your backup application or your virtual tape library (VTL). For more information, see Viewing Tape Usage. New Region Storage Gateway is now available in the Asia Pacific (Mumbai) Region. For detailed information, see AWS May 02, 2017 Regions that support Storage Gateway. Updates to file share settings File Gateways now add mount options to the file share settings. You can now set squash and read- March 28, 2017 Support for cache refresh for file shares only options for your file share. For more informati on, see Create a file share. File Gateways now can find objects in the Amazon S3 bucket that were added or removed since the gateway last listed the bucket's contents and cached the results. For more information, see RefreshCache in the API Reference. Earlier updates API Version 2013-06-30 366 AWS Storage Gateway Volume Gateway User Guide Change Description Support for cloning a volume For cached Volume Gateways, AWS Storage Gateway now supports the ability to clone a volume from an existing volume. For more information, see Cloning a Volume. Date Changed March 16, 2017 Support for File Gateways on AWS Storage Gateway now provides the ability to deploy a File Gateway in Amazon EC2. You can Amazon EC2 launch a File Gateway in Amazon EC2 using the February 08, 2017 Storage Gateway Amazon Machine Image (AMI) now available as a community AMI. For information about how to create a File Gateway and deploy it on an EC2 instance, see Create and activate an Amazon S3 File Gateway or Create and activate an Amazon FSx File Gateway. For information about how to launch a File Gateway AMI, see Deploying an S3 File Gateway on an Amazon EC2 host or Deploying FSx File Gateway on an Amazon EC2 host. Compatibility with Arcserve 17 Tape Gateway is now compatible with Arcserve 17. You can now use Arcserve to back up your data to January 17, 2017 Amazon S3 and archive directly to S3 Glacier Flexible Retrieval. For more information, see Testing Your Setup by Using Arcserve Backup r17.0. New Region New Region Storage Gateway is now available in the EU (London) Region. For detailed information, see AWS Regions that support Storage Gateway. December 13, 2016 Storage Gateway is now available in the Canada (Central) Region. For detailed information, see AWS Regions that support Storage Gateway. December 08, 2016 Earlier updates API Version 2013-06-30 367 AWS Storage Gateway Change Description Volume Gateway User Guide Date Changed Support for File Gateway In addition to Volume Gateways and Tape Gateway, Storage Gateway now provides File Gateway. File November 29, 2016 Gateway combines a service and virtual
|
storagegateway-vgw-ug-132
|
storagegateway-vgw-ug.pdf
| 132 |
by Using Arcserve Backup r17.0. New Region New Region Storage Gateway is now available in the EU (London) Region. For detailed information, see AWS Regions that support Storage Gateway. December 13, 2016 Storage Gateway is now available in the Canada (Central) Region. For detailed information, see AWS Regions that support Storage Gateway. December 08, 2016 Earlier updates API Version 2013-06-30 367 AWS Storage Gateway Change Description Volume Gateway User Guide Date Changed Support for File Gateway In addition to Volume Gateways and Tape Gateway, Storage Gateway now provides File Gateway. File November 29, 2016 Gateway combines a service and virtual software appliance, allowing you to store and retrieve objects in Amazon S3 using industry-standard file protocols such as Network File System (NFS). The gateway provides access to objects in Amazon S3 as files on an NFS mount point. Backup Exec 16 Tape Gateway is now compatible with Backup Exec 16. You can now use Backup Exec 16 to back up your November 7, 2016 data to Amazon S3 and archive directly to offline storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Testing Y our Setup by Using Veritas Backup Exec. Compatibility with Micro Focus (HPE) Tape Gateway is now compatible with Micro Focus (HPE) Data Protector 9.x. You can now use HPE Data November 2, 2016 Data Protector 9.x Protector to back up your data to Amazon S3 and archive directly to S3 Glacier Flexible Retrieval. For more information, see Testing Your Setup by Using Micro Focus (HPE) Data Protector. New Region Storage Gateway is now available in the US East (Ohio) Region. For detailed information, see AWS Regions that support Storage Gateway. October 17, 2016 Storage Gateway console redesign August 30, 2016 The Storage Gateway Management Console has been redesigned to make it easier to configure, manage, and monitor your gateways, volumes, and virtual tapes. The user interface now provides views that can be filtered and provides direct links to integrated AWS services such as CloudWatch and Amazon EBS. For more information, see Sign Up for AWS Storage Gateway. Earlier updates API Version 2013-06-30 368 AWS Storage Gateway Volume Gateway User Guide Change Description Compatibility with Veeam Backup Tape Gateway is now compatible with Veeam Backup & Replication V9 Update 2 or later (that is, version & Replication V9 9.0.0.1715 or later). You can now use Veeam Backup Update 2 or later Replication V9 Update 2 or later to back up your Date Changed August 15, 2016 data to Amazon S3 and archive directly to offline storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Testing Your Setup by Using Veeam Backup & Replication. Longer volume and snapshot IDs Storage Gateway is introducing longer IDs for volumes and snapshots. You can activate the longer April 25, 2016 ID format for your volumes, snapshots, and other supported AWS resources. For more information, see Understanding Storage Gateway Resources and Resource IDs. New Region Support for storage up to 512 Tape Gateway is now available in the Asia Pacific (Seoul) Region. For more information, see AWS Regions that support Storage Gateway. March 21, 2016 TiB in size for For stored volumes, you can now create up to 32 stored volumes storage volumes up to 16 TiB in size each, for a maximum of 512 TiB of storage. For more informati on, see Stored volumes architecture and AWS Storage Gateway quotas. Other gateway updates and enhancements to the Storage Total size of all tapes in a virtual tape library is Gateway local increased to 1 PiB. For more information, see AWS console Storage Gateway quotas. You can now set the password for your VM local console on the Storage Gateway Console. For information, see Setting the Local Console Password from the Storage Gateway Console. Earlier updates API Version 2013-06-30 369 Volume Gateway User Guide Date Changed February 29, 2016 October 20, 2015 AWS Storage Gateway Change Description Compatibility with for Dell EMC Tape Gateway is now compatible with Dell EMC NetWorker 8.x. You can now use Dell EMC NetWorker NetWorker 8.x to back up your data to Amazon S3 and archiv e directly to offline storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Testing Your Setup by Using Dell EMC NetWorker. Support for VMware ESXi AWS Storage Gateway now supports the VMware ESXi Hypervisor version 6.0 and the Red Hat Hypervisor version Enterprise Linux 7 iSCSI initiator. For more infor 6.0 and Red Hat Enterprise Linux 7 mation, see Supported hypervisors and host requirements and Supported iSCSI initiators. iSCSI initiator Content restructu re This release includes this improvement: The documentation now includes a Managing Your Activated Gateway section that combines m anagement tasks that are common to all gateway solutions. Following, you can find instructions on
|
storagegateway-vgw-ug-133
|
storagegateway-vgw-ug.pdf
| 133 |
Glacier Deep Archive). For more information, see Testing Your Setup by Using Dell EMC NetWorker. Support for VMware ESXi AWS Storage Gateway now supports the VMware ESXi Hypervisor version 6.0 and the Red Hat Hypervisor version Enterprise Linux 7 iSCSI initiator. For more infor 6.0 and Red Hat Enterprise Linux 7 mation, see Supported hypervisors and host requirements and Supported iSCSI initiators. iSCSI initiator Content restructu re This release includes this improvement: The documentation now includes a Managing Your Activated Gateway section that combines m anagement tasks that are common to all gateway solutions. Following, you can find instructions on how you can manage your gateway after you have deployed and activated it. For more information, see Managing Your Volume Gateway. Earlier updates API Version 2013-06-30 370 AWS Storage Gateway Change Description Volume Gateway User Guide Date Changed Support for storage up to For cached volumes, you can now create up to 32 storage volumes at up to 32 TiB each for a maximum September 16, 2015 1,024 TiB in size of 1,024 TiB of storage. For more information, see for cached vol Cached volumes architecture and AWS Storage umes Gateway quotas. Support for the VMXNET3 (10 GbE) network adapter type in If your gateway is hosted on a VMware ESXi hypervisor, you can reconfigure the gateway to use the VMXNET3 adapter type. For more information, see Configuring network adapters for your gateway. VMware ESXi The maximum upload rate for Storage Gateway has hypervisor increased to 120 MB a second, and the maximum download rate has increased to 20 MB a second. Performance enhancements The Storage Gateway local console has been updated and enhanced with additional features to help you perform maintenance tasks. For more information, Miscellaneous see Configuring Your Gateway Network. enhancements and updates to the Storage Gateway local console Support for tagging Storage Gateway now supports resource tagging. You can now add tags to gateways, volumes, and virtual tapes to make them easier to manage. For more information, see Tagging Storage Gateway Resources. September 2, 2015 Earlier updates API Version 2013-06-30 371 AWS Storage Gateway Volume Gateway User Guide Change Description Compatibility with Quest (formerly Tape Gateway is now compatible with Quest NetVault Backup 10.0. You can now use Quest Dell) NetVault NetVault Backup 10.0 to back up your data to Backup 10.0 Amazon S3 and archive directly to offline storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Testing Your Setup by Using Quest NetVault Backup. Date Changed June 22, 2015 Earlier updates API Version 2013-06-30 372 AWS Storage Gateway Volume Gateway User Guide Change Description Support for 16 TiB storage Storage Gateway now supports 16 TiB storage volumes for stored volumes gateway setups. You volumes for can now create 12 16 TiB storage volumes for a stored volumes maximum of 192 TiB of storage. For more informati gateway setups on, see Stored volumes architecture. Date Changed June 3, 2015 Support for You can now determine whether your system system resource resources (virtual CPU cores, root volume size, and checks on the RAM) are sufficient for your gateway to function Storage Gateway properly. For more information, see Viewing your local console gateway system resource status or Viewing your gateway system resource status. Support for the Red Hat Enterpris Storage Gateway now supports the Red Hat Enterpris e Linux 6 iSCSI e Linux 6 iSCSI initiator. For more information, see initiator Requirements for setting up Volume Gateway. This release includes the following Storage Gateway improvements and updates: • • From the Storage Gateway console, you can now see the date and time the last successful software update was applied to your gateway. For more information, see Managing gateway updates. Storage Gateway now provides an API you can use to list iSCSI initiators connected to your storage volumes. For more information, see ListVolum eInitiators in the API reference. Earlier updates API Version 2013-06-30 373 AWS Storage Gateway Volume Gateway User Guide Change Description Support for Microsoft Hyper- Storage Gateway now supports Microsoft Hyper- V hypervisor versions 2012 and 2012 R2. This is V hypervisor in addition to support for Microsoft Hyper-V hy versions 2012 and pervisor version 2008 R2. For more information, see 2012 R2 Supported hypervisors and host requirements. Date Changed April 30, 2015 Compatibility with Symantec Backup Tape Gateway is now compatible with Symantec Backup Exec 15. You can now use Symantec Backup April 6, 2015 Exec 15 Exec 15 to back up your data to Amazon S3 and archive directly to offline storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Testing Your Setup by Using Veritas Backup Exec. CHAP authentic ation support for Storage Gateway now supports configuring CHAP authentication for storage volumes. For more April 2, 2015 storage volumes information, see Configure CHAP authentication
|
storagegateway-vgw-ug-134
|
storagegateway-vgw-ug.pdf
| 134 |
R2 Supported hypervisors and host requirements. Date Changed April 30, 2015 Compatibility with Symantec Backup Tape Gateway is now compatible with Symantec Backup Exec 15. You can now use Symantec Backup April 6, 2015 Exec 15 Exec 15 to back up your data to Amazon S3 and archive directly to offline storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Testing Your Setup by Using Veritas Backup Exec. CHAP authentic ation support for Storage Gateway now supports configuring CHAP authentication for storage volumes. For more April 2, 2015 storage volumes information, see Configure CHAP authentication for your volumes. Support for VMware ESXi Storage Gateway now supports VMware ESXi Hypervisor versions 5.1 and 5.5. This is in addition March 30, 2015 Hypervisor version to support for VMware ESXi Hypervisor versions 5.1 and 5.5 4.1 and 5.0. For more information, see Supported hypervisors and host requirements. Support for Windows CHKDSK utility Storage Gateway now supports the Windows CHKDSK utility. You can use this utility to verify the integrity of your volumes and fix errors on the volumes. For more information, see Troubleshooting volume issues. March 04, 2015 Earlier updates API Version 2013-06-30 374 AWS Storage Gateway Change Description Volume Gateway User Guide Date Changed Integration with AWS CloudTrail to Storage Gateway is now integrated with AWS CloudTrail. AWS CloudTrail captures API calls made December 16, 2014 capture API calls by or on behalf of Storage Gateway in your Amazon Web Services account and delivers the log files to an Amazon S3 bucket that you specify. For more information, see Logging and Monitoring in AWS Storage Gateway. This release includes the following Storage Gateway improvement and update: • Virtual tapes that have dirty data in cache storage (that is, that contain content that has not been uploaded to AWS) are now recovered when a gateway's cached drive changes. For more information, see Recovering a Virtual Tape From An Unrecoverable Gateway. Earlier updates API Version 2013-06-30 375 AWS Storage Gateway Change Description Volume Gateway User Guide Date Changed Compatibility with additional backup software and medium cha nger Tape Gateway is now compatible with the following backup software: November 3, 2014 • • • • Symantec Backup Exec 2014 Microsoft System Center 2012 R2 Data Protection Manager Veeam Backup & Replication V7 Veeam Backup & Replication V8 You can now use these four backup software products with the Storage Gateway virtual tape library (VTL) to back up to Amazon S3 and archive directly to offline storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Using Your Backup Software to Test Your Gateway Setup. Storage Gateway now provides an additional medium changer that works with the new backup software. This release includes miscellaneous AWS Storage Gateway improvements and updates. Europe (Frankfurt) Region Storage Gateway is now available in the Europe (Frankfurt) Region. For detailed information, see AWS Regions that support Storage Gateway. October 23, 2014 Earlier updates API Version 2013-06-30 376 AWS Storage Gateway Volume Gateway User Guide Change Description Content restructu re Created a Getting Started section that is common to all gateway solutions. Following, you can find Date Changed May 19, 2014 instructions for you to download, deploy, and activate a gateway. After you deploy and activate a gateway, you can proceed to further instructions specific to stored volumes, cached volumes, and Tape Gateway setups. For more information, see Creating a Tape Gateway. Compatibility with Symantec Backup Tape Gateway is now compatible with Symantec Backup Exec 2012. You can now use Symantec April 28, 2014 Exec 2012 Backup Exec 2012 to back up your data to Amazon S3 and archive directly to offline storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Testing Your Setup by Using Veritas Backup Exec. Earlier updates API Version 2013-06-30 377 Volume Gateway User Guide Date Changed January 31, 2014 AWS Storage Gateway Change Description Support for Windows Server Failover Clustering Support for VMware ESX initiator Support for performing configuration tasks on Storage Gateway local console • • • Storage Gateway now supports connecting multiple hosts to the same volume if the hosts coordinate access by using Windows Server Failover Clustering (WSFC). However, you can't co nnect multiple hosts to that same volume without using WSFC. Storage Gateway now allows you to manage storage connectivity directly through your ESX host. This provides an alternative to using initiator s resident in the guest OS of your VMs. Storage Gateway now provides support for performing configuration tasks in the Storage Gateway local console. For information about performing configuration tasks on gateways deployed on-premises, see Performing Tasks on the VM Local Console or Performing Tasks on the VM Local Console. For information about performing configuration tasks on gateways deployed on an EC2 instance, see Performing Tasks on
|
storagegateway-vgw-ug-135
|
storagegateway-vgw-ug.pdf
| 135 |
can't co nnect multiple hosts to that same volume without using WSFC. Storage Gateway now allows you to manage storage connectivity directly through your ESX host. This provides an alternative to using initiator s resident in the guest OS of your VMs. Storage Gateway now provides support for performing configuration tasks in the Storage Gateway local console. For information about performing configuration tasks on gateways deployed on-premises, see Performing Tasks on the VM Local Console or Performing Tasks on the VM Local Console. For information about performing configuration tasks on gateways deployed on an EC2 instance, see Performing Tasks on the Amazon EC2 Local Console or Performing Tasks on the Amazon EC2 Local Console. Earlier updates API Version 2013-06-30 378 AWS Storage Gateway Change Description Volume Gateway User Guide Date Changed Support for virtual tape library (VTL) Storage Gateway connects an on-premises software appliance with cloud-based storage to integrate your November 5, 2013 on-premises IT environment with the AWS storage and introduction infrastructure. In addition to Volume Gateways of API version (cached volumes and stored volumes), Storage 2013-06-30 Gateway now supports gateway–virtual tape library (VTL). You can configure Tape Gateway with up to 10 virtual tape drives per gateway. Each virtual tape drive responds to the SCSI command set, so your existing on-premises backup applications will work without modification. For more information, see the following topics in the AWS Storage Gateway User Guide. • • For an architectural overview, see How Tape Gateway works (architecture). To get started with Tape Gateway, see Creating a Tape Gateway. Support for Microsoft Hyper-V Storage Gateway now provides the ability to deploy an on-premises gateway on the Microsoft Hyper- April 10, 2013 V virtualization platform. Gateways deployed on Microsoft Hyper-V have all the same functionality and features as the existing on-premises Storage Gateway. To get started deploying a gateway with Microsoft Hyper-V, see Supported hypervisors and host requirements. Earlier updates API Version 2013-06-30 379 AWS Storage Gateway Change Description Support for deploying a gateway on Amazon EC2 Storage Gateway now provides the ability to deploy a gateway in Amazon Elastic Compute Cloud (Amazon EC2). You can launch a gateway instance in Amazon EC2 using the Storage Gateway AMI available in AWS Marketplace. To get started deploying a gateway using the Storage Gateway AMI, see Deploy a customized Amazon EC2 instance for Volume Gateway. Volume Gateway User Guide Date Changed January 15, 2013 Earlier updates API Version 2013-06-30 380 AWS Storage Gateway Change Description Support for cached volumes In this release, Storage Gateway introduces support for cached volumes. Cached volumes minimize the and introduction need to scale your on-premises storage infrastruct of API Version 20 ure, while still providing your applications with 12-06-30 low-latency access to their active data. You can Volume Gateway User Guide Date Changed October 29, 2012 create storage volumes up to 32 TiB in size and mount them as iSCSI devices from your on-premis es application servers. Data written to your cached volumes is stored in Amazon Simple Storage Service (Amazon S3), with only a cache of recently written and recently read data stored locally on your on- premises storage hardware. Cached volumes allow you to utilize Amazon S3 for data where higher retrieval latencies are acceptable, such as for older, infrequently accessed data, while maintaining storage on-premises for data where low-latency access is required. In this release, Storage Gateway also introduces a new API version that, in addition to supporting the current operations, provides new operations to support cached volumes. For more information on the two Storage Gateway solutions, see How Volume Gateway works. You can also try a test setup. For instructions, see Creating a Tape Gateway. Earlier updates API Version 2013-06-30 381 AWS Storage Gateway Volume Gateway User Guide Change Description API and IAM support In this release, Storage Gateway introduces API support as well as support for AWS Identity and Access Management(IAM). Date Changed May 9, 2012 • • API support—You can now programmatically configure and manage your Storage Gateway resources. For more information about the API, see API Reference for Storage Gateway in the AWS Storage Gateway User Guide. IAM support – AWS Identity and Access Management (IAM) lets you create users and manage user access to your Storage Gateway resources by means of IAM policies. For examples of IAM policies, see Identity and Access Management for AWS Storage Gateway. For more information about IAM, see AWS Identity and Access Management (IAM) detail page. Static IP support You can now specify a static IP for your local gateway. For more information, see Configuring Your March 5, 2012 Gateway Network. New guide This is the first release of AWS Storage Gateway User Guide. January 24, 2012 Earlier updates API Version 2013-06-30 382 AWS Storage Gateway Volume Gateway User Guide Release notes for Volume Gateway appliance software These
|
storagegateway-vgw-ug-136
|
storagegateway-vgw-ug.pdf
| 136 |
to your Storage Gateway resources by means of IAM policies. For examples of IAM policies, see Identity and Access Management for AWS Storage Gateway. For more information about IAM, see AWS Identity and Access Management (IAM) detail page. Static IP support You can now specify a static IP for your local gateway. For more information, see Configuring Your March 5, 2012 Gateway Network. New guide This is the first release of AWS Storage Gateway User Guide. January 24, 2012 Earlier updates API Version 2013-06-30 382 AWS Storage Gateway Volume Gateway User Guide Release notes for Volume Gateway appliance software These release notes describe the new and updated features, improvements, and fixes that are included with each version of the Volume Gateway appliance. Each software version is identified by its release date and a unique version number. You can determine a gateway's software version number by checking its Details page in the Storage Gateway console, or by calling the DescribeGatewayInformation API action using an AWS CLI command similar to the following: aws storagegateway describe-gateway-information --gateway-arn "arn:aws:storagegateway:us-west-2:123456789012:gateway/sgw-12A3456B" The version number is returned in the SoftwareVersion field of the API response. Note A gateway won't report software version information under the following circumstances: • The gateway is offline. • The gateway is running older software that doesn't support version reporting. • The gateway type is FSx File Gateway. For more information about Volume Gateway updates, including how to modify the default automatic maintenance and update schedule for a gateway, see Managing Gateway Updates Using the AWS Storage Gateway Console. Release Date Software Version Release Notes 2025-05-01 2.12.8 2025-04-01 2.12.7 • Updated operating system and software elements to improve security and performance for new and existing gateways • Updated operating system and software elements API Version 2013-06-30 383 AWS Storage Gateway Volume Gateway User Guide Release Date Software Version Release Notes 2025-03-04 2.12.6 2025-02-04 2.12.5 2025-01-07 2.12.3 2024-12-06 2.12.2 to improve security and performance for new and existing gateways • Updated operating system and software elements to improve security and performance for new and existing gateways • Updated operating system and software elements to improve security and performance for new and existing gateways • Addressed an issue where gateways could get stuck in shutdown state after a software update • Updated operating system and software elements to improve security and performance for new and existing gateways • Updated operating system and software elements to improve security and performance for new and existing gateways API Version 2013-06-30 384 AWS Storage Gateway Volume Gateway User Guide Release Date Software Version Release Notes 2024-11-06 2.12.1 2024-10-03 2.12.0 2024-08-30 2.11.0 2024-07-29 2.10.0 • Updated operating system and software elements to improve security and performance for new and existing gateways • Addressed an issue where iSCSI initiator would not automatically reconnect with volumes after gateway restart or gateway sofware update • Updated operating system and software elements to improve security and performance for new and existing gateways • Updated operating system and software elements to improve security and performance for new and existing gateways • Updated operating system and software elements to improve security and performance for new and existing gateways • Miscellaneous bug fixes and enhancements API Version 2013-06-30 385 AWS Storage Gateway Volume Gateway User Guide Release Date Software Version Release Notes 2024-06-17 2.9.2 2024-05-28 2.9.0 • Updated operating system and software elements to improve security and performance for new and existing gateways • Reduced gateway restart time during software updates • Reduced the amount of data transferred for estimating network bandwidth 2024-05-08 2.8.3 • Addressed cloud connectiv 2024-04-10 2.8.1 2024-03-06 2.8.0 ity issue when using SOCKS5 proxy • Addressed a memory usage issue introduced in 2.8.0 • Security patch updates • Improved software update process • Addressed missing Network Time Protocol (NTP) component for new gateways • Updated operating system and software elements to improve security and performance for new gateways • Security patch updates API Version 2013-06-30 386 AWS Storage Gateway Volume Gateway User Guide Release Date Software Version Release Notes 2023-12-19 2.7.0 • Updated operating system and software elements to improve security and performance for new gateways 2023-12-14 2.6.6 • Maintenance release API Version 2013-06-30 387
|
sts-api-001
|
sts-api.pdf
| 1 |
API Reference AWS Security Token Service API Version 2011-06-15 Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. AWS Security Token Service API Reference AWS Security Token Service: 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 Security Token Service Table of Contents API Reference Welcome ........................................................................................................................................... 1 Endpoints ........................................................................................................................................................ 1 Recording API requests ............................................................................................................................... 2 Actions .............................................................................................................................................. 3 AssumeRole .................................................................................................................................................... 4 Request Parameters ................................................................................................................................ 5 Response Elements ............................................................................................................................... 13 Errors ....................................................................................................................................................... 14 Examples ................................................................................................................................................. 15 See Also .................................................................................................................................................. 17 AssumeRoleWithSAML ............................................................................................................................... 18 Request Parameters .............................................................................................................................. 21 Response Elements ............................................................................................................................... 24 Errors ....................................................................................................................................................... 26 Examples ................................................................................................................................................. 28 See Also .................................................................................................................................................. 29 AssumeRoleWithWebIdentity ................................................................................................................... 31 Request Parameters .............................................................................................................................. 33 Response Elements ............................................................................................................................... 38 Errors ....................................................................................................................................................... 40 Examples ................................................................................................................................................. 41 See Also .................................................................................................................................................. 42 AssumeRoot ................................................................................................................................................. 44 Request Parameters .............................................................................................................................. 44 Response Elements ............................................................................................................................... 45 Errors ....................................................................................................................................................... 46 Examples ................................................................................................................................................. 47 See Also .................................................................................................................................................. 47 DecodeAuthorizationMessage .................................................................................................................. 49 Request Parameters .............................................................................................................................. 49 Response Elements ............................................................................................................................... 50 Errors ....................................................................................................................................................... 50 Examples ................................................................................................................................................. 50 See Also .................................................................................................................................................. 52 API Version 2011-06-15 iii AWS Security Token Service API Reference GetAccessKeyInfo ........................................................................................................................................ 53 Request Parameters .............................................................................................................................. 53 Response Elements ............................................................................................................................... 54 Errors ....................................................................................................................................................... 54 Examples ................................................................................................................................................. 54 See Also .................................................................................................................................................. 55 GetCallerIdentity ......................................................................................................................................... 56 Response Elements ............................................................................................................................... 56 Errors ....................................................................................................................................................... 57 Examples ................................................................................................................................................. 57 See Also .................................................................................................................................................. 60 GetFederationToken ................................................................................................................................... 61 Request Parameters .............................................................................................................................. 63 Response Elements ............................................................................................................................... 66 Errors ....................................................................................................................................................... 67 Examples ................................................................................................................................................. 68 See Also .................................................................................................................................................. 69 GetSessionToken ......................................................................................................................................... 71 Request Parameters .............................................................................................................................. 72 Response Elements ............................................................................................................................... 73 Errors ....................................................................................................................................................... 74 Examples ................................................................................................................................................. 74 See Also .................................................................................................................................................. 75 Data Types ..................................................................................................................................... 76 AssumedRoleUser ....................................................................................................................................... 77 Contents .................................................................................................................................................. 77 See Also .................................................................................................................................................. 77 Credentials ................................................................................................................................................... 79 Contents .................................................................................................................................................. 79 See Also .................................................................................................................................................. 79 FederatedUser ............................................................................................................................................. 81 Contents .................................................................................................................................................. 81 See Also .................................................................................................................................................. 81 PolicyDescriptorType ................................................................................................................................. 83 Contents .................................................................................................................................................. 83 See Also .................................................................................................................................................. 83 API Version 2011-06-15 iv AWS Security Token Service API Reference ProvidedContext ......................................................................................................................................... 84 Contents .................................................................................................................................................. 84 See Also .................................................................................................................................................. 84 Tag ................................................................................................................................................................. 86 Contents .................................................................................................................................................. 86 See Also .................................................................................................................................................. 86 Common Parameters ..................................................................................................................... 88 Common Errors .............................................................................................................................. 91 API Version 2011-06-15 v AWS Security Token Service API Reference Welcome to the AWS Security Token Service API Reference AWS provides AWS Security Token Service (AWS STS) as a web service that enables you to request temporary, limited-privilege credentials for users. This guide describes the AWS STS API. For more information, see Temporary Security Credentials in the IAM User Guide. Note As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms such as Java, Ruby, .NET, iOS, Android, and others. The SDKs provide a convenient way to create programmatic access to AWS STS. For example, the SDKs can cryptographically sign requests, manage errors, and retry requests automatically. For information about the AWS SDKs, see Tools to Build on AWS. For information about setting up signatures and authorization through the API, see Signing AWS API Requests in the Amazon Web Services General Reference. For general information about the Query API, see Making Query Requests in the IAM User Guide. For information about using security tokens with other AWS products, see AWS Services That Work with IAM in the IAM User Guide. Endpoints The AWS Security Token Service (AWS STS) is available as a global service endpoint at https:// sts.amazonaws.com and as Regional service endpoints. In Regions that are enabled by default, requests to the AWS STS global endpoint are automatically served in the same Region where the request originates. In opt-in Regions, requests to the AWS STS global endpoint are served by a single AWS Region, US East (N. Virginia). For more information, see AWS STS Regions and endpoints in the IAM User Guide. AWS recommends using Regional AWS STS endpoints instead of the global endpoint to reduce latency, built-in redundancy, and increase session token validity. For more information, see Managing AWS STS in an AWS Region in the IAM User Guide. Most AWS Regions enable operations in all AWS services by default. These Regions automatically activate for use with AWS STS. Some Regions, such as Asia Pacific (Hong Kong), must be manually Endpoints API Version 2011-06-15 1 AWS Security Token Service API Reference enabled. To learn more about enabling and disabling AWS Regions, see Managing AWS Regions in the Amazon Web Services General Reference. When you enable
|
sts-api-002
|
sts-api.pdf
| 2 |
AWS STS endpoints instead of the global endpoint to reduce latency, built-in redundancy, and increase session token validity. For more information, see Managing AWS STS in an AWS Region in the IAM User Guide. Most AWS Regions enable operations in all AWS services by default. These Regions automatically activate for use with AWS STS. Some Regions, such as Asia Pacific (Hong Kong), must be manually Endpoints API Version 2011-06-15 1 AWS Security Token Service API Reference enabled. To learn more about enabling and disabling AWS Regions, see Managing AWS Regions in the Amazon Web Services General Reference. When you enable these AWS Regions, they are automatically activated for use with AWS STS. You cannot activate the AWS STS endpoint for a disabled Region. Tokens that are valid in all AWS Regions include more characters than tokens that are valid in Regions enabled by default. Changing this setting might affect existing systems where you temporarily store tokens. For more information, see Managing Global Endpoint Session Tokens in the IAM User Guide. After you activate a Region for use with AWS STS, you can direct AWS STS API calls to that Region. AWS STS recommends you provide both the Region and endpoint when you send calls to a Regional endpoint. You can provide the Region alone for manually enabled Regions, such as Asia Pacific (Hong Kong). In this case, you direct the calls to the AWS STS Regional endpoint. However, if you provide the Region alone for Regions enabled by default, AWS STS directs the calls to the global endpoint of https://sts.amazonaws.com. To view the list of AWS STS endpoints and if they are active by default, see Writing Code to Use AWS STS Regions in the IAM User Guide. Recording API requests AWS STS supports AWS CloudTrail, a service that records AWS calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine the requests successfully sent to AWS STS, as well as who sent the request, and when it was sent. For more information about CloudTrail, including how to enable it and find your log files, see Logging IAM and AWS STS API calls with AWS CloudTrail in the IAM User Guide and the AWS CloudTrail User Guide. Recording API requests API Version 2011-06-15 2 AWS Security Token Service API Reference Actions The following actions are supported: • AssumeRole • AssumeRoleWithSAML • AssumeRoleWithWebIdentity • AssumeRoot • DecodeAuthorizationMessage • GetAccessKeyInfo • GetCallerIdentity • GetFederationToken • GetSessionToken API Version 2011-06-15 3 AWS Security Token Service AssumeRole API Reference Returns a set of temporary security credentials that you can use to access AWS resources. These temporary credentials consist of an access key ID, a secret access key, and a security token. Typically, you use AssumeRole within your account or for cross-account access. For a comparison of AssumeRole with other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Compare AWS STS credentials in the IAM User Guide. Permissions The temporary security credentials created by AssumeRole can be used to make API calls to any AWS service with the following exception: You cannot call the AWS STS GetFederationToken or GetSessionToken API operations. (Optional) You can pass inline or managed session policies to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity- based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide. When you create a role, you create two policies: a role trust policy that specifies who can assume the role, and a permissions policy that specifies what can be done with the role. You specify the trusted principal that is allowed to assume the role in the role trust policy. To assume a role from a different account, your AWS account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. That trust policy states which accounts are allowed to delegate that access to users in the account. A user who wants to access a role in a different account must also have permissions that are delegated from the account administrator. The
|
sts-api-003
|
sts-api.pdf
| 3 |
policy that specifies what can be done with the role. You specify the trusted principal that is allowed to assume the role in the role trust policy. To assume a role from a different account, your AWS account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. That trust policy states which accounts are allowed to delegate that access to users in the account. A user who wants to access a role in a different account must also have permissions that are delegated from the account administrator. The administrator must attach a policy that allows the user to call AssumeRole for the ARN of the role in the other account. To allow a user to assume a role in the same account, you can do either of the following: AssumeRole API Version 2011-06-15 4 AWS Security Token Service API Reference • Attach a policy to the user that allows the user to call AssumeRole (as long as the role's trust policy trusts the account). • Add the user as a principal directly in the role's trust policy. You can do either because the role’s trust policy acts as an IAM resource-based policy. When a resource-based policy grants access to a principal in the same account, no additional identity-based policy is required. For more information about trust policies and resource-based policies, see IAM Policies in the IAM User Guide. Tags (Optional) You can pass tag key-value pairs to your session. These tags are called session tags. For more information about session tags, see Passing Session Tags in AWS STS in the IAM User Guide. An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access Control in the IAM User Guide. You can set the session tags as transitive. Transitive tags persist during role chaining. For more information, see Chaining Roles with Session Tags in the IAM User Guide. Using MFA with AssumeRole (Optional) You can include multi-factor authentication (MFA) information when you call AssumeRole. This is useful for cross-account scenarios to ensure that the user that assumes the role has been authenticated with an AWS MFA device. In that scenario, the trust policy of the role being assumed includes a condition that tests for MFA authentication. If the caller does not include valid MFA information, the request to assume the role is denied. The condition in a trust policy that tests for MFA authentication might look like the following example. "Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}} For more information, see Configuring MFA-Protected API Access in the IAM User Guide guide. To use MFA with AssumeRole, you pass values for the SerialNumber and TokenCode parameters. The SerialNumber value identifies the user's hardware or virtual MFA device. The TokenCode is the time-based one-time password (TOTP) that the MFA device produces. Request Parameters For information about the parameters that are common to all actions, see Common Parameters. Request Parameters API Version 2011-06-15 5 AWS Security Token Service DurationSeconds API Reference The duration, in seconds, of the role session. The value specified can range from 900 seconds (15 minutes) up to the maximum session duration set for the role. The maximum session duration setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting or the administrator setting (whichever is lower), the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. Role chaining limits your AWS CLI or AWS API role session to a maximum of one hour. When you use the AssumeRole API operation to assume a role, you can specify the duration of your role session with the DurationSeconds parameter. You can specify a parameter value of up to 43200 seconds (12 hours), depending on the maximum session duration setting for your role. However, if you assume a role using role chaining and provide a DurationSeconds parameter value greater than one hour, the operation fails. To learn how to view the maximum value for your role, see Update the maximum session duration for a role. By default, the value is set to 3600 seconds. Note The DurationSeconds parameter is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a SessionDuration parameter that specifies the maximum length of the console session. For more information, see Creating a URL that Enables Federated Users to Access the AWS Management Console in the IAM User Guide. Type: Integer Valid Range: Minimum value of
|
sts-api-004
|
sts-api.pdf
| 4 |
to view the maximum value for your role, see Update the maximum session duration for a role. By default, the value is set to 3600 seconds. Note The DurationSeconds parameter is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a SessionDuration parameter that specifies the maximum length of the console session. For more information, see Creating a URL that Enables Federated Users to Access the AWS Management Console in the IAM User Guide. Type: Integer Valid Range: Minimum value of 900. Maximum value of 43200. Required: No ExternalId A unique identifier that might be required when you assume a role in another account. If the administrator of the account to which the role belongs provided you with an external ID, then provide that value in the ExternalId parameter. This value can be any string, such as Request Parameters API Version 2011-06-15 6 AWS Security Token Service API Reference a passphrase or account number. A cross-account role is usually set up to trust everyone in an account. Therefore, the administrator of the trusting account might send an external ID to the administrator of the trusted account. That way, only someone with the ID can assume the role, rather than everyone in the account. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the IAM User Guide. The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: +=,.@:\/- Type: String Length Constraints: Minimum length of 2. Maximum length of 1224. Pattern: [\w+=,.@:\/-]* Required: No Policy An IAM policy in JSON format that you want to use as an inline session policy. This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\u0020 through \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters. Note An AWS conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The Request Parameters API Version 2011-06-15 7 AWS Security Token Service API Reference PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit. For more information about role session permissions, see Session policies. Type: String Length Constraints: Minimum length of 1. Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+ Required: No PolicyArns.member.N The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role. This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. Note An AWS conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide. Request Parameters API Version 2011-06-15 8 AWS Security Token Service API Reference Type: Array of PolicyDescriptorType objects Required: No ProvidedContexts.member.N A
|
sts-api-005
|
sts-api.pdf
| 5 |
to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide. Request Parameters API Version 2011-06-15 8 AWS Security Token Service API Reference Type: Array of PolicyDescriptorType objects Required: No ProvidedContexts.member.N A list of previously acquired trusted context assertions in the format of a JSON array. The trusted context assertion is signed and encrypted by AWS STS. The following is an example of a ProvidedContext value that includes a single trusted context assertion and the ARN of the context provider from which the trusted context assertion was generated. [{"ProviderArn":"arn:aws:iam::aws:contextProvider/ IdentityCenter","ContextAssertion":"trusted-context-assertion"}] Type: Array of ProvidedContext objects Array Members: Maximum number of 5 items. Required: No RoleArn The Amazon Resource Name (ARN) of the role to assume. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD \u10000-\u10FFFF]+ Required: Yes RoleSessionName An identifier for the assumed role session. Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also Request Parameters API Version 2011-06-15 9 AWS Security Token Service API Reference used in the ARN of the assumed role principal. This means that subsequent cross-account API requests that use the temporary security credentials will expose the role session name to the external account in their AWS CloudTrail logs. For security purposes, administrators can view this field in AWS CloudTrail logs to help identify who performed an action in AWS. Your administrator might require that you specify your user name as the session name when you assume the role. For more information, see sts:RoleSessionName. The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: +=,.@- Type: String Length Constraints: Minimum length of 2. Maximum length of 64. Pattern: [\w+=,.@-]* Required: Yes SerialNumber The identification number of the MFA device that is associated with the user who is making the AssumeRole call. Specify this value if the trust policy of the role being assumed includes a condition that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: +=/:,.@- Type: String Length Constraints: Minimum length of 9. Maximum length of 256. Pattern: [\w+=/:,.@-]* Required: No Request Parameters API Version 2011-06-15 10 AWS Security Token Service SourceIdentity API Reference The source identity specified by the principal that is calling the AssumeRole operation. The source identity value persists across chained role sessions. You can require users to specify a source identity when they assume a role. You do this by using the sts:SourceIdentity condition key in a role trust policy. You can use source identity information in AWS CloudTrail logs to determine who took actions with a role. You can use the aws:SourceIdentity condition key to further control access to AWS resources based on the value of source identity. For more information about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide. The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: +=,.@-. You cannot use a value that begins with the text aws:. This prefix is reserved for AWS internal use. Type: String Length Constraints: Minimum length of 2. Maximum length of 64. Pattern: [\w+=,.@-]* Required: No Tags.member.N A list of session tags that you want to pass. Each session tag consists of a key name and an associated value. For more information about session tags, see Tagging AWS STS Sessions in the IAM User Guide. This parameter is optional. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. For these and additional limits, see IAM and AWS STS Character Limits in the IAM User Guide. Note An AWS conversion compresses the
|
sts-api-006
|
sts-api.pdf
| 6 |
of 2. Maximum length of 64. Pattern: [\w+=,.@-]* Required: No Tags.member.N A list of session tags that you want to pass. Each session tag consists of a key name and an associated value. For more information about session tags, see Tagging AWS STS Sessions in the IAM User Guide. This parameter is optional. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. For these and additional limits, see IAM and AWS STS Character Limits in the IAM User Guide. Note An AWS conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The Request Parameters API Version 2011-06-15 11 AWS Security Token Service API Reference PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit. You can pass a session tag with the same key as a tag that is already attached to the role. When you do, session tags override a role tag with the same key. Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have separate Department and department tag keys. Assume that the role has the Department=Marketing tag and you pass the department=engineering session tag. Department and department are not saved as separate tags, and the session tag passed in the request takes precedence over the role tag. Additionally, if you used temporary credentials to perform this operation, the new session inherits any transitive session tags from the calling session. If you pass a session tag with the same key as an inherited tag, the operation fails. To view the inherited tags for a session, see the AWS CloudTrail logs. For more information, see Viewing Session Tags in CloudTrail in the IAM User Guide. Type: Array of Tag objects Array Members: Maximum number of 50 items. Required: No TokenCode The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. (In other words, if the policy includes a condition that tests for MFA). If the role being assumed requires MFA and if the TokenCode value is missing or expired, the AssumeRole call returns an "access denied" error. The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits. Type: String Length Constraints: Fixed length of 6. Pattern: [\d]* Request Parameters API Version 2011-06-15 12 AWS Security Token Service Required: No TransitiveTagKeys.member.N API Reference A list of keys for session tags that you want to set as transitive. If you set a tag key as transitive, the corresponding key and value passes to subsequent sessions in a role chain. For more information, see Chaining Roles with Session Tags in the IAM User Guide. This parameter is optional. The transitive status of a session tag does not impact its packed binary size. If you choose not to specify a transitive tag key, then no tags are passed from this session to any subsequent sessions. Type: Array of strings Array Members: Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]+ Required: No Response Elements The following elements are returned by the service. AssumedRoleUser The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole. Type: AssumedRoleUser object Credentials The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token. Response Elements API Version 2011-06-15 13 AWS Security Token Service API Reference Note The size of the security token that AWS STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size. Type: Credentials object PackedPolicySize A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space. Type: Integer Valid Range: Minimum value of 0. SourceIdentity The source identity specified by the principal that is calling the AssumeRole operation. You can require users to specify a source identity when they assume a role. You do this by using the sts:SourceIdentity condition key in a role trust policy. You can use source identity information in AWS CloudTrail logs to determine
|
sts-api-007
|
sts-api.pdf
| 7 |
indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space. Type: Integer Valid Range: Minimum value of 0. SourceIdentity The source identity specified by the principal that is calling the AssumeRole operation. You can require users to specify a source identity when they assume a role. You do this by using the sts:SourceIdentity condition key in a role trust policy. You can use source identity information in AWS CloudTrail logs to determine who took actions with a role. You can use the aws:SourceIdentity condition key to further control access to AWS resources based on the value of source identity. For more information about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide. The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- Type: String Length Constraints: Minimum length of 2. Maximum length of 64. Pattern: [\w+=,.@-]* Errors For information about the errors that are common to all actions, see Common Errors. Errors API Version 2011-06-15 14 AWS Security Token Service ExpiredToken API Reference The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request. HTTP Status Code: 400 MalformedPolicyDocument The request was rejected because the policy document was malformed. The error message describes the specific error. HTTP Status Code: 400 PackedPolicyTooLarge The request was rejected because the total packed size of the session policies and session tags combined was too large. An AWS conversion compresses the session policy document, session policy ARNs, and session tags into a packed binary format that has a separate limit. The error message indicates by percentage how close the policies and tags are to the upper size limit. For more information, see Passing Session Tags in AWS STS in the IAM User Guide. You could receive this error even though you meet other defined session policy and session tag limits. For more information, see IAM and AWS STS Entity Character Limits in the IAM User Guide. HTTP Status Code: 400 RegionDisabled AWS STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate AWS STS in that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the IAM User Guide. HTTP Status Code: 403 Examples Example This example illustrates one usage of AssumeRole. Examples API Version 2011-06-15 15 API Reference AWS Security Token Service Sample Request https://sts.amazonaws.com/ ?Version=2011-06-15 &Action=AssumeRole &RoleSessionName=testAR &RoleArn=arn:aws:iam::123456789012:role/demo &PolicyArns.member.1.arn=arn:aws:iam::123456789012:policy/demopolicy1 &PolicyArns.member.2.arn=arn:aws:iam::123456789012:policy/demopolicy2 &Policy={"Version":"2012-10-17","Statement":[{"Sid":"Stmt1", "Effect":"Allow","Action":"s3:*","Resource":"*"}]} &DurationSeconds=3600 &Tags.member.1.Key=Project &Tags.member.1.Value=Pegasus &Tags.member.2.Key=Team &Tags.member.2.Value=Engineering &Tags.member.3.Key=Cost-Center &Tags.member.3.Value=12345 &TransitiveTagKeys.member.1=Project &TransitiveTagKeys.member.2=Cost-Center &ExternalId=123ABC &SourceIdentity=Alice &AUTHPARAMS Sample Response <AssumeRoleResponse xmlns="https://sts.amazonaws.com/doc/2011-06-15/"> <AssumeRoleResult> <SourceIdentity>Alice</SourceIdentity> <AssumedRoleUser> <Arn>arn:aws:sts::123456789012:assumed-role/demo/TestAR</Arn> <AssumedRoleId>ARO123EXAMPLE123:TestAR</AssumedRoleId> </AssumedRoleUser> <Credentials> <AccessKeyId>ASIAIOSFODNN7EXAMPLE</AccessKeyId> <SecretAccessKey>wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY</SecretAccessKey> <SessionToken> AQoDYXdzEPT//////////wEXAMPLEtc764bNrC9SAPBSM22wDOk4x4HIZ8j4FZTwdQW LWsKWHGBuFqwAeMicRXmxfpSPfIeoIYRqTflfKD8YUuwthAx7mSEI/qkPpKPi/kMcGd QrmGdeehM4IC1NtBmUpp2wUE8phUZampKsburEDy0KPkyQDYwT7WZ0wq5VSXDvp75YU 9HFvlRd8Tx6q6fE8YQcHNVXAkiY9q6d+xo0rKwT38xVqr7ZD0u0iPPkUL64lIZbqBAz +scqKmlzm8FDrypNC9Yjc8fPOLn9FX9KSYvKTr4rvx3iSIlTJabIQwj2ICCR/oLxBA== </SessionToken> Examples API Version 2011-06-15 16 AWS Security Token Service API Reference <Expiration>2019-11-09T13:34:41Z</Expiration> </Credentials> <PackedPolicySize>6</PackedPolicySize> </AssumeRoleResult> <ResponseMetadata> <RequestId>c6104cbe-af31-11e0-8154-cbc7ccf896c7</RequestId> </ResponseMetadata> </AssumeRoleResponse> 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 2011-06-15 17 AWS Security Token Service API Reference AssumeRoleWithSAML Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based AWS access without user-specific credentials or configuration. For a comparison of AssumeRoleWithSAML with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Compare AWS STS credentials in the IAM User Guide. The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS services. Note AssumeRoleWithSAML will not work on AWS IAM Identity Center managed roles. These roles' names start with AWSReservedSSO_. Session Duration By default, the temporary security credentials created by AssumeRoleWithSAML last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. Your role session lasts for the duration that you specify, or until the time specified in the SAML authentication response's SessionNotOnOrAfter value, whichever is shorter. You can provide a DurationSeconds value
|
sts-api-008
|
sts-api.pdf
| 8 |
a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS services. Note AssumeRoleWithSAML will not work on AWS IAM Identity Center managed roles. These roles' names start with AWSReservedSSO_. Session Duration By default, the temporary security credentials created by AssumeRoleWithSAML last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. Your role session lasts for the duration that you specify, or until the time specified in the SAML authentication response's SessionNotOnOrAfter value, whichever is shorter. You can provide a DurationSeconds value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide. Note Role chaining limits your AWS CLI or AWS API role session to a maximum of one hour. When you use the AssumeRole API operation to assume a role, you can specify the duration of your role session with the DurationSeconds parameter. You can specify a AssumeRoleWithSAML API Version 2011-06-15 18 AWS Security Token Service API Reference parameter value of up to 43200 seconds (12 hours), depending on the maximum session duration setting for your role. However, if you assume a role using role chaining and provide a DurationSeconds parameter value greater than one hour, the operation fails. Permissions The temporary security credentials created by AssumeRoleWithSAML can be used to make API calls to any AWS service with the following exception: you cannot call the AWS STS GetFederationToken or GetSessionToken API operations. (Optional) You can pass inline or managed session policies to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity- based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide. Calling AssumeRoleWithSAML does not require the use of AWS security credentials. The identity of the caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your identity provider. Important Calling AssumeRoleWithSAML can result in an entry in your AWS CloudTrail logs. The entry includes the value in the NameID element of the SAML assertion. We recommend that you use a NameIDType that is not associated with any personally identifiable information (PII). For example, you could instead use the persistent identifier (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent). Tags AssumeRoleWithSAML API Version 2011-06-15 19 AWS Security Token Service API Reference (Optional) You can configure your IdP to pass attributes into your SAML assertion as session tags. Each session tag consists of a key name and an associated value. For more information about session tags, see Passing Session Tags in AWS STS in the IAM User Guide. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these and additional limits, see IAM and AWS STS Character Limits in the IAM User Guide. Note An AWS conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit. You can pass a session tag with the same key as a tag that is attached to the role. When you do, session tags override the role's tags with the same key. An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access Control in the
|
sts-api-009
|
sts-api.pdf
| 9 |
plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit. You can pass a session tag with the same key as a tag that is attached to the role. When you do, session tags override the role's tags with the same key. An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access Control in the IAM User Guide. You can set the session tags as transitive. Transitive tags persist during role chaining. For more information, see Chaining Roles with Session Tags in the IAM User Guide. SAML Configuration Before your application can call AssumeRoleWithSAML, you must configure your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, you must use AWS Identity and Access Management (IAM) to create a SAML provider entity in your AWS account that represents your identity provider. You must also create an IAM role that specifies this SAML provider in its trust policy. For more information, see the following resources: • About SAML 2.0-based Federation in the IAM User Guide. • Creating SAML Identity Providers in the IAM User Guide. AssumeRoleWithSAML API Version 2011-06-15 20 AWS Security Token Service API Reference • Configuring a Relying Party and Claims in the IAM User Guide. • Creating a Role for SAML 2.0 Federation in the IAM User Guide. Request Parameters For information about the parameters that are common to all actions, see Common Parameters. DurationSeconds The duration, in seconds, of the role session. Your role session lasts for the duration that you specify for the DurationSeconds parameter, or until the time specified in the SAML authentication response's SessionNotOnOrAfter value, whichever is shorter. You can provide a DurationSeconds value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. By default, the value is set to 3600 seconds. Note The DurationSeconds parameter is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a SessionDuration parameter that specifies the maximum length of the console session. For more information, see Creating a URL that Enables Federated Users to Access the AWS Management Console in the IAM User Guide. Type: Integer Valid Range: Minimum value of 900. Maximum value of 43200. Required: No Policy An IAM policy in JSON format that you want to use as an inline session policy. Request Parameters API Version 2011-06-15 21 AWS Security Token Service API Reference This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\u0020 through \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters. For more information about role session permissions, see Session policies. Note An AWS conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+ Required: No PolicyArns.member.N The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role. This parameter is optional. You can provide up to 10 managed policy ARNs. However,
|
sts-api-010
|
sts-api.pdf
| 10 |
separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+ Required: No PolicyArns.member.N The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role. This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. Request Parameters API Version 2011-06-15 22 AWS Security Token Service API Reference Note An AWS conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide. Type: Array of PolicyDescriptorType objects Required: No PrincipalArn The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD \u10000-\u10FFFF]+ Required: Yes RoleArn The Amazon Resource Name (ARN) of the role that the caller is assuming. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD \u10000-\u10FFFF]+ Request Parameters API Version 2011-06-15 23 AWS Security Token Service Required: Yes SAMLAssertion API Reference The base64 encoded SAML authentication response provided by the IdP. For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide. Type: String Length Constraints: Minimum length of 4. Maximum length of 100000. Required: Yes Response Elements The following elements are returned by the service. AssumedRoleUser The identifiers for the temporary security credentials that the operation returns. Type: AssumedRoleUser object Audience The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion. Type: String Credentials The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token. Note The size of the security token that AWS STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size. Type: Credentials object Response Elements API Version 2011-06-15 24 AWS Security Token Service Issuer The value of the Issuer element of the SAML assertion. API Reference Type: String NameQualifier A hash value based on the concatenation of the following: • The Issuer response value. • The AWS account ID. • The friendly name (the last part of the ARN) of the SAML provider in IAM. The combination of NameQualifier and Subject can be used to uniquely identify a user. The following pseudocode shows how the hash value is calculated: BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/ MySAMLIdP" ) ) Type: String PackedPolicySize A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space. Type: Integer Valid Range: Minimum value of 0. SourceIdentity The value in the SourceIdentity attribute in the SAML assertion. The source identity value persists across chained role sessions. You can require users to set a source identity value when they assume a role. You do this by using the sts:SourceIdentity condition key in a role trust policy. That way, actions that are taken with the role are associated with that user. After the source identity is set, the value cannot be changed. It is present in the request for all actions that are taken by the role and persists across chained role sessions. You can configure your SAML identity provider to use an attribute associated with your users, like user name or email, as the source identity when calling Response Elements API Version 2011-06-15 25 AWS Security Token Service API Reference AssumeRoleWithSAML. You do this by adding an
|
sts-api-011
|
sts-api.pdf
| 11 |
the sts:SourceIdentity condition key in a role trust policy. That way, actions that are taken with the role are associated with that user. After the source identity is set, the value cannot be changed. It is present in the request for all actions that are taken by the role and persists across chained role sessions. You can configure your SAML identity provider to use an attribute associated with your users, like user name or email, as the source identity when calling Response Elements API Version 2011-06-15 25 AWS Security Token Service API Reference AssumeRoleWithSAML. You do this by adding an attribute to the SAML assertion. For more information about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide. The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- Type: String Length Constraints: Minimum length of 2. Maximum length of 64. Pattern: [\w+=,.@-]* Subject The value of the NameID element in the Subject element of the SAML assertion. Type: String SubjectType The format of the name ID, as defined by the Format attribute in the NameID element of the SAML assertion. Typical examples of the format are transient or persistent. If the format includes the prefix urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. For example, urn:oasis:names:tc:SAML:2.0:nameid- format:transient is returned as transient. If the format includes any other prefix, the format is returned with no modifications. Type: String Errors For information about the errors that are common to all actions, see Common Errors. ExpiredToken The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request. HTTP Status Code: 400 Errors API Version 2011-06-15 26 AWS Security Token Service IDPRejectedClaim API Reference The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid. If this error is returned for the AssumeRoleWithWebIdentity operation, it can also mean that the claim has expired or has been explicitly revoked. HTTP Status Code: 403 InvalidIdentityToken The web identity token that was passed could not be validated by AWS. Get a new identity token from the identity provider and then retry the request. HTTP Status Code: 400 MalformedPolicyDocument The request was rejected because the policy document was malformed. The error message describes the specific error. HTTP Status Code: 400 PackedPolicyTooLarge The request was rejected because the total packed size of the session policies and session tags combined was too large. An AWS conversion compresses the session policy document, session policy ARNs, and session tags into a packed binary format that has a separate limit. The error message indicates by percentage how close the policies and tags are to the upper size limit. For more information, see Passing Session Tags in AWS STS in the IAM User Guide. You could receive this error even though you meet other defined session policy and session tag limits. For more information, see IAM and AWS STS Entity Character Limits in the IAM User Guide. HTTP Status Code: 400 RegionDisabled AWS STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate AWS STS in that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the IAM User Guide. Errors API Version 2011-06-15 27 AWS Security Token Service HTTP Status Code: 403 Examples Example API Reference This example requires that the TestSaml role and the SAML-test SAML identity provider are configured in IAM. Additionally, this example requires an encoded SAML assertion that includes all of the necessary information. For more information about SAML assertions, see Configuring SAML Assertions for the Authentication Response in the IAM User Guide. Sample Request https://sts.amazonaws.com/ ?Version=2011-06-15 &Action=AssumeRoleWithSAML &RoleArn=arn:aws:iam::123456789012:role/TestSaml &PrincipalArn=arn:aws:iam::123456789012:saml-provider/SAML-test &SAMLAssertion=VERYLONGENCODEDASSERTIONEXAMPLExzYW1sOkF1ZGllbmNl PmJsYW5rPC9zYW1sOkF1ZGllbmNlPjwvc2FtbDpBdWRpZW5jZVJlc3RyaWN0aW9u Pjwvc2FtbDpDb25kaXRpb25zPjxzYW1sOlN1YmplY3Q+PHNhbWw6TmFtZUlEIEZv cm1hdD0idXJuOm9hc2lzOm5hbWVzOnRjOlNBTUw6Mi4wOm5hbWVpZC1mb3JtYXQ6 dHJhbnNpZW50Ij5TYW1sRXhhbXBsZTwvc2FtbDpOYW1lSUQ+PHNhbWw6U3ViamVj dENvbmZpcm1hdGlvbiBNZXRob2Q9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIu MDpjbTpiZWFyZXIiPjxzYW1sOlN1YmplY3RDb25maXJtYXRpb25EYXRhIE5vdE9u T3JBZnRlcj0iMjAxOS0xMS0wMVQyMDoyNTowNS4xNDVaIiBSZWNpcGllbnQ9Imh0 dHBzOi8vc2lnbmluLmF3cy5hbWF6b24uY29tL3NhbWwiLz48L3NhbWw6U3ViamVj dENvbmZpcm1hdGlvbj48L3NhbWw6U3ViamVjdD48c2FtbDpBdXRoblN0YXRlbWVu dCBBdXRoPD94bWwgdmpSZXNwb25zZT4= &AUTHPARAMS Sample Response <AssumeRoleWithSAMLResponse xmlns="https://sts.amazonaws.com/doc/2011-06-15/"> <AssumeRoleWithSAMLResult> <Issuer> https://integ.example.com/idp/shibboleth</Issuer> <AssumedRoleUser> <Arn>arn:aws:sts::123456789012:assumed-role/TestSaml</Arn> <AssumedRoleId>ARO456EXAMPLE789:TestSaml</AssumedRoleId> </AssumedRoleUser> <Credentials> Examples API Version 2011-06-15 28 AWS Security Token Service API Reference <AccessKeyId>ASIAV3ZUEFP6EXAMPLE</AccessKeyId> <SecretAccessKey>8P+SQvWIuLnKhh8d++jpw0nNmQRBZvNEXAMPLEKEY</ SecretAccessKey> <SessionToken> IQoJb3JpZ2luX2VjEOz//////////////////// wEXAMPLEtMSJHMEUCIDoKK3JH9uG QE1z0sINr5M4jk+Na8KHDcCYRVjJCZEvOAiEA3OvJGtw1EcViOleS2vhs8VdCKFJQWP QrmGdeehM4IC1NtBmUpp2wUE8phUZampKsburEDy0KPkyQDYwT7WZ0wq5VSXDvp75YU 9HFvlRd8Tx6q6fE8YQcHNVXAkiY9q6d+xo0rKwT38xVqr7ZD0u0iPPkUL64lIZbqBAz +scqKmlzm8FDrypNC9Yjc8fPOLn9FX9KSYvKTr4rvx3iSIlTJabIQwj2ICCR/oLxBA== </ SessionToken> <Expiration>2019-11-01T20:26:47Z</Expiration> </Credentials> <Audience>https://signin.aws.amazon.com/saml</Audience> <SubjectType>transient</SubjectType> <PackedPolicySize>6</PackedPolicySize> <NameQualifier>SbdGOnUkh1i4+EXAMPLExL/jEvs=</NameQualifier> <SourceIdentity>SourceIdentityValue</SourceIdentity> <Subject>SamlExample</Subject> </AssumeRoleWithSAMLResult> <ResponseMetadata> <RequestId>c6104cbe-af31-11e0-8154-cbc7ccf896c7</RequestId> </ResponseMetadata> </AssumeRoleWithSAMLResponse> 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 2011-06-15 29 AWS Security Token Service API
|
sts-api-012
|
sts-api.pdf
| 12 |
</ SessionToken> <Expiration>2019-11-01T20:26:47Z</Expiration> </Credentials> <Audience>https://signin.aws.amazon.com/saml</Audience> <SubjectType>transient</SubjectType> <PackedPolicySize>6</PackedPolicySize> <NameQualifier>SbdGOnUkh1i4+EXAMPLExL/jEvs=</NameQualifier> <SourceIdentity>SourceIdentityValue</SourceIdentity> <Subject>SamlExample</Subject> </AssumeRoleWithSAMLResult> <ResponseMetadata> <RequestId>c6104cbe-af31-11e0-8154-cbc7ccf896c7</RequestId> </ResponseMetadata> </AssumeRoleWithSAMLResponse> 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 2011-06-15 29 AWS Security Token Service API Reference See Also API Version 2011-06-15 30 AWS Security Token Service API Reference AssumeRoleWithWebIdentity Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider. Example providers include the OAuth 2.0 providers Login with Amazon and Facebook, or any OpenID Connect-compatible identity provider such as Google or Amazon Cognito federated identities. Note For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the AWS SDK for iOS Developer Guide and the AWS SDK for Android Developer Guide to uniquely identify a user. You can also supply the user with a consistent identity throughout the lifetime of an application. To learn more about Amazon Cognito, see Amazon Cognito identity pools in Amazon Cognito Developer Guide. Calling AssumeRoleWithWebIdentity does not require the use of AWS security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term AWS credentials in the application. You also don't need to deploy server-based proxy services that use long-term AWS credentials. Instead, the identity of the caller is validated by using a token from the web identity provider. For a comparison of AssumeRoleWithWebIdentity with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Compare AWS STS credentials in the IAM User Guide. The temporary security credentials returned by this API consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS service API operations. Session Duration By default, the temporary security credentials created by AssumeRoleWithWebIdentity last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. You can provide a value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see Update the maximum session duration for a role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* AssumeRoleWithWebIdentity API Version 2011-06-15 31 AWS Security Token Service API Reference API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide. Permissions The temporary security credentials created by AssumeRoleWithWebIdentity can be used to make API calls to any AWS service with the following exception: you cannot call the AWS STS GetFederationToken or GetSessionToken API operations. (Optional) You can pass inline or managed session policies to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity- based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide. Tags (Optional) You can configure your IdP to pass attributes into your web identity token as session tags. Each session tag consists of a key name and an associated value. For more information about session tags, see Passing session tags using AssumeRoleWithWebIdentity in the IAM User Guide. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these and additional limits, see IAM and AWS STS Character Limits in the IAM User Guide. Note An AWS conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate
|
sts-api-013
|
sts-api.pdf
| 13 |
identity token as session tags. Each session tag consists of a key name and an associated value. For more information about session tags, see Passing session tags using AssumeRoleWithWebIdentity in the IAM User Guide. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these and additional limits, see IAM and AWS STS Character Limits in the IAM User Guide. Note An AWS conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit. AssumeRoleWithWebIdentity API Version 2011-06-15 32 AWS Security Token Service API Reference You can pass a session tag with the same key as a tag that is attached to the role. When you do, the session tag overrides the role tag with the same key. An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access Control in the IAM User Guide. You can set the session tags as transitive. Transitive tags persist during role chaining. For more information, see Chaining Roles with Session Tags in the IAM User Guide. Identities Before your application can call AssumeRoleWithWebIdentity, you must have an identity token from a supported identity provider and create a role that the application can assume. The role that your application assumes must trust the identity provider that is associated with the identity token. In other words, the identity provider must be specified in the role's trust policy. Important Calling AssumeRoleWithWebIdentity can result in an entry in your AWS CloudTrail logs. The entry includes the Subject of the provided web identity token. We recommend that you avoid using any personally identifiable information (PII) in this field. For example, you could instead use a GUID or a pairwise identifier, as suggested in the OIDC specification. For more information about how to use OIDC federation and the AssumeRoleWithWebIdentity API, see the following resources: • Using Web Identity Federation API Operations for Mobile Apps and Federation Through a Web- based Identity Provider. • AWS SDK for iOS Developer Guide and AWS SDK for Android Developer Guide. These toolkits contain sample apps that show how to invoke the identity providers. The toolkits then show how to use the information from these providers to get and use temporary security credentials. Request Parameters For information about the parameters that are common to all actions, see Common Parameters. Request Parameters API Version 2011-06-15 33 AWS Security Token Service DurationSeconds API Reference The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. By default, the value is set to 3600 seconds. Note The DurationSeconds parameter is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a SessionDuration parameter that specifies the maximum length of the console session. For more information, see Creating a URL that Enables Federated Users to Access the AWS Management Console in the IAM User Guide. Type: Integer Valid Range: Minimum value of 900. Maximum value of 43200. Required: No Policy An IAM policy in JSON format that you want to use as an inline session policy. This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the
|
sts-api-014
|
sts-api.pdf
| 14 |
credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to Request Parameters API Version 2011-06-15 34 AWS Security Token Service API Reference the end of the valid character list (\u0020 through \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters. For more information about role session permissions, see Session policies. Note An AWS conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+ Required: No PolicyArns.member.N The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role. This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. Note An AWS conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit. Request Parameters API Version 2011-06-15 35 AWS Security Token Service API Reference Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide. Type: Array of PolicyDescriptorType objects Required: No ProviderId The fully qualified host component of the domain name of the OAuth 2.0 identity provider. Do not specify this value for an OpenID Connect identity provider. Currently www.amazon.com and graph.facebook.com are the only supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port numbers. Do not specify this value for OpenID Connect ID tokens. Type: String Length Constraints: Minimum length of 4. Maximum length of 2048. Required: No RoleArn The Amazon Resource Name (ARN) of the role that the caller is assuming. Note Additional considerations apply to Amazon Cognito identity pools that assume cross-account IAM roles. The trust policies of these roles must accept the cognito- identity.amazonaws.com service principal and must contain the cognito- identity.amazonaws.com:aud condition key to restrict role assumption to users from your intended identity pools. A policy that trusts Amazon Cognito identity pools without this condition creates a risk that a user from an unintended identity pool can assume the role. For more information, see Trust policies for IAM roles in Basic (Classic) authentication in the Amazon Cognito Developer Guide. Request Parameters API Version 2011-06-15 36 AWS Security Token Service Type: String API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD \u10000-\u10FFFF]+ Required: Yes RoleSessionName An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the AssumedRoleUser response element. For security purposes, administrators can view this field in AWS CloudTrail logs to help identify who performed an action in AWS. Your administrator might require that you specify your user name as the session name when you assume the role. For more information, see sts:RoleSessionName. The regex used to validate this parameter is a string of characters consisting of upper-
|
sts-api-015
|
sts-api.pdf
| 15 |
who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the AssumedRoleUser response element. For security purposes, administrators can view this field in AWS CloudTrail logs to help identify who performed an action in AWS. Your administrator might require that you specify your user name as the session name when you assume the role. For more information, see sts:RoleSessionName. The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- Type: String Length Constraints: Minimum length of 2. Maximum length of 64. Pattern: [\w+=,.@-]* Required: Yes WebIdentityToken The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an AssumeRoleWithWebIdentity call. Timestamps in the token must be formatted as either an integer or a long integer. Tokens must be signed using either RSA keys (RS256, RS384, or RS512) or ECDSA keys (ES256, ES384, or ES512). Type: String Request Parameters API Version 2011-06-15 37 AWS Security Token Service API Reference Length Constraints: Minimum length of 4. Maximum length of 20000. Required: Yes Response Elements The following elements are returned by the service. AssumedRoleUser The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole. Type: AssumedRoleUser object Audience The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token. Type: String Credentials The temporary security credentials, which include an access key ID, a secret access key, and a security token. Note The size of the security token that AWS STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size. Type: Credentials object PackedPolicySize A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space. Response Elements API Version 2011-06-15 38 AWS Security Token Service Type: Integer Valid Range: Minimum value of 0. Provider API Reference The issuing authority of the web identity token presented. For OpenID Connect ID tokens, this contains the value of the iss field. For OAuth 2.0 access tokens, this contains the value of the ProviderId parameter that was passed in the AssumeRoleWithWebIdentity request. Type: String SourceIdentity The value of the source identity that is returned in the JSON web token (JWT) from the identity provider. You can require users to set a source identity value when they assume a role. You do this by using the sts:SourceIdentity condition key in a role trust policy. That way, actions that are taken with the role are associated with that user. After the source identity is set, the value cannot be changed. It is present in the request for all actions that are taken by the role and persists across chained role sessions. You can configure your identity provider to use an attribute associated with your users, like user name or email, as the source identity when calling AssumeRoleWithWebIdentity. You do this by adding a claim to the JSON web token. To learn more about OIDC tokens and claims, see Using Tokens with User Pools in the Amazon Cognito Developer Guide. For more information about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide. The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- Type: String Length Constraints: Minimum length of 2. Maximum length of 64. Pattern: [\w+=,.@-]* SubjectFromWebIdentityToken The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken that was submitted with the AssumeRoleWithWebIdentity call. The identifier is typically unique to the user and the application that acquired the Response Elements API Version 2011-06-15 39 AWS Security Token Service API Reference WebIdentityToken (pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's
|
sts-api-016
|
sts-api.pdf
| 16 |
spaces. You can also include underscores or any of the following characters: =,.@- Type: String Length Constraints: Minimum length of 2. Maximum length of 64. Pattern: [\w+=,.@-]* SubjectFromWebIdentityToken The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken that was submitted with the AssumeRoleWithWebIdentity call. The identifier is typically unique to the user and the application that acquired the Response Elements API Version 2011-06-15 39 AWS Security Token Service API Reference WebIdentityToken (pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's sub (Subject) claim. Type: String Length Constraints: Minimum length of 6. Maximum length of 255. Errors For information about the errors that are common to all actions, see Common Errors. ExpiredToken The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request. HTTP Status Code: 400 IDPCommunicationError The request could not be fulfilled because the identity provider (IDP) that was asked to verify the incoming identity token could not be reached. This is often a transient error caused by network conditions. Retry the request a limited number of times so that you don't exceed the request rate. If the error persists, the identity provider might be down or not responding. HTTP Status Code: 400 IDPRejectedClaim The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid. If this error is returned for the AssumeRoleWithWebIdentity operation, it can also mean that the claim has expired or has been explicitly revoked. HTTP Status Code: 403 InvalidIdentityToken The web identity token that was passed could not be validated by AWS. Get a new identity token from the identity provider and then retry the request. HTTP Status Code: 400 Errors API Version 2011-06-15 40 AWS Security Token Service MalformedPolicyDocument API Reference The request was rejected because the policy document was malformed. The error message describes the specific error. HTTP Status Code: 400 PackedPolicyTooLarge The request was rejected because the total packed size of the session policies and session tags combined was too large. An AWS conversion compresses the session policy document, session policy ARNs, and session tags into a packed binary format that has a separate limit. The error message indicates by percentage how close the policies and tags are to the upper size limit. For more information, see Passing Session Tags in AWS STS in the IAM User Guide. You could receive this error even though you meet other defined session policy and session tag limits. For more information, see IAM and AWS STS Entity Character Limits in the IAM User Guide. HTTP Status Code: 400 RegionDisabled AWS STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate AWS STS in that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the IAM User Guide. HTTP Status Code: 403 Examples Example This example illustrates one usage of AssumeRoleWithWebIdentity. Sample Request https://sts.amazonaws.com/ ?Action=AssumeRoleWithWebIdentity &DurationSeconds=3600 Examples API Version 2011-06-15 41 AWS Security Token Service API Reference &PolicyArns.member.1.arn=arn:aws:iam::123456789012:policy/webidentitydemopolicy1 &PolicyArns.member.2.arn=arn:aws:iam::123456789012:policy/webidentitydemopolicy2 &ProviderId=www.amazon.com &RoleSessionName=app1 &RoleArn=arn:aws:iam::123456789012:role/FederatedWebIdentityRole &WebIdentityToken=Atza%7CIQEBLjAsAhRFiXuWpUXuRvQ9PZL3GMFcYevydwIUFAHZwXZXX XXXXXXJnrulxKDHwy87oGKPznh0D6bEQZTSCzyoCtL_8S07pLpr0zMbn6w1lfVZKNTBdDansFB mtGnIsIapjI6xKR02Yc_2bQ8LZbUXSGm6Ry6_BG7PrtLZtj_dfCTj92xNGed-CrKqjG7nPBjNI L016GGvuS5gSvPRUxWES3VYfm1wl7WTI7jn-Pcb6M-buCgHhFOzTQxod27L9CqnOLio7N3gZAG psp6n1-AJBOCJckcyXe2c6uD0srOJeZlKUm2eTDVMf8IehDVI0r1QOnTV6KzzAI3OY87Vd_cVMQ &Version=2011-06-15 Sample Response <AssumeRoleWithWebIdentityResponse xmlns="https://sts.amazonaws.com/doc/2011-06-15/"> <AssumeRoleWithWebIdentityResult> <SubjectFromWebIdentityToken>amzn1.account.AF6RHO7KZU5XRVQJGXK6HB56KR2A</ SubjectFromWebIdentityToken> <Audience>[email protected]</Audience> <AssumedRoleUser> <Arn>arn:aws:sts::123456789012:assumed-role/FederatedWebIdentityRole/app1</Arn> <AssumedRoleId>AROACLKWSDQRAOEXAMPLE:app1</AssumedRoleId> </AssumedRoleUser> <Credentials> <SessionToken>AQoDYXdzEE0a8ANXXXXXXXXNO1ewxE5TijQyp+IEXAMPLE</SessionToken> <SecretAccessKey>wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY</SecretAccessKey> <Expiration>2014-10-24T23:00:23Z</Expiration> <AccessKeyId>ASgeIAIOSFODNN7EXAMPLE</AccessKeyId> </Credentials> <SourceIdentity>SourceIdentityValue</SourceIdentity> <Provider>www.amazon.com</Provider> </AssumeRoleWithWebIdentityResult> <ResponseMetadata> <RequestId>ad4156e9-bce1-11e2-82e6-6b6efEXAMPLE</RequestId> </ResponseMetadata> </AssumeRoleWithWebIdentityResponse> See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2011-06-15 42 API Reference AWS Security Token Service • 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 2011-06-15 43 AWS Security Token Service AssumeRoot API Reference Returns a set of short term credentials you can use to perform privileged tasks on a member account in your organization. You must use credentials from an AWS Organizations management account or a delegated administrator account for IAM to call AssumeRoot. You cannot use root user credentials to make this call. Before you can launch a privileged session, you must have centralized root access in your organization. For steps to enable this feature, see Centralize root access for member accounts in the IAM User Guide. Note The AWS STS global endpoint is not supported for AssumeRoot. You must send this request to a Regional AWS STS endpoint. For more information, see Endpoints. You can track AssumeRoot in AWS CloudTrail logs to determine what actions were performed in a session.
|
sts-api-017
|
sts-api.pdf
| 17 |
management account or a delegated administrator account for IAM to call AssumeRoot. You cannot use root user credentials to make this call. Before you can launch a privileged session, you must have centralized root access in your organization. For steps to enable this feature, see Centralize root access for member accounts in the IAM User Guide. Note The AWS STS global endpoint is not supported for AssumeRoot. You must send this request to a Regional AWS STS endpoint. For more information, see Endpoints. You can track AssumeRoot in AWS CloudTrail logs to determine what actions were performed in a session. For more information, see Track privileged tasks in AWS CloudTrail in the IAM User Guide. When granting access to privileged tasks you should only grant the necessary permissions required to perform that task. For more information, see Security best practices in IAM. In addition, you can use service control policies (SCPs) to manage and limit permissions in your organization. See General examples in the AWS Organizations User Guide for more information on SCPs. Request Parameters For information about the parameters that are common to all actions, see Common Parameters. DurationSeconds The duration, in seconds, of the privileged session. The value can range from 0 seconds up to the maximum session duration of 900 seconds (15 minutes). If you specify a value higher than this setting, the operation fails. By default, the value is set to 900 seconds. Type: Integer Valid Range: Minimum value of 0. Maximum value of 900. AssumeRoot API Version 2011-06-15 44 API Reference AWS Security Token Service Required: No TargetPrincipal The member account principal ARN or account ID. Type: String Length Constraints: Minimum length of 12. Maximum length of 2048. Required: Yes TaskPolicyArn The identity based policy that scopes the session to the privileged tasks that can be performed. You must use one of following AWS managed policies to scope root session actions: • IAMAuditRootUserCredentials • IAMCreateRootUserPassword • IAMDeleteRootUserCredentials • S3UnlockBucketPolicy • SQSUnlockQueuePolicy Type: PolicyDescriptorType object Required: Yes Response Elements The following elements are returned by the service. Credentials The temporary security credentials, which include an access key ID, a secret access key, and a security token. Note The size of the security token that AWS STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size. Response Elements API Version 2011-06-15 45 AWS Security Token Service Type: Credentials object SourceIdentity API Reference The source identity specified by the principal that is calling the AssumeRoot operation. You can use the aws:SourceIdentity condition key to control access based on the value of source identity. For more information about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide. The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- Type: String Length Constraints: Minimum length of 2. Maximum length of 64. Pattern: [\w+=,.@-]* Errors For information about the errors that are common to all actions, see Common Errors. ExpiredToken The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request. HTTP Status Code: 400 RegionDisabled AWS STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate AWS STS in that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the IAM User Guide. HTTP Status Code: 403 Errors API Version 2011-06-15 46 API Reference AWS Security Token Service Examples Example This example illustrates one usage of AssumeRoot. Sample Request https://sts.amazonaws.com/ ?Version=2011-06-15 &Action=AssumeRoot &DurationSeconds=900 &TargetPrincipal=111122223333 &TaskPolicyArn.arn=arn:aws:iam::aws:policy/root-task/IAMDeleteRootUserCredentials Sample Response <AssumeRootResponse xmlns="https://sts.amazonaws.com/doc/2011-06-15/"> <AssumeRootResult> <SourceIdentity>Alice</SourceIdentity> <Credentials> <AccessKeyId>ASIAIOSFODNN7EXAMPLE</AccessKeyId> <SecretAccessKey>wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY</SecretAccessKey> <SessionToken> AQoDYXdzEPT//////////wEXAMPLEtc764bNrC9SAPBSM22wDOk4x4HIZ8j4FZTwdQW LWsKWHGBuFqwAeMicRXmxfpSPfIeoIYRqTflfKD8YUuwthAx7mSEI/qkPpKPi/kMcGd QrmGdeehM4IC1NtBmUpp2wUE8phUZampKsburEDy0KPkyQDYwT7WZ0wq5VSXDvp75YU 9HFvlRd8Tx6q6fE8YQcHNVXAkiY9q6d+xo0rKwT38xVqr7ZD0u0iPPkUL64lIZbqBAz +scqKmlzm8FDrypNC9Yjc8fPOLn9FX9KSYvKTr4rvx3iSIlTJabIQwj2ICCR/oLxBA== </SessionToken> <Expiration>2019-11-09T13:34:41Z</Expiration> </Credentials> </AssumeRoleResult> <ResponseMetadata> <RequestId>c6104cbe-af31-11e0-8154-cbc7ccf896c7</RequestId> </ResponseMetadata> </AssumeRootResponse> See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Examples API Version 2011-06-15 47 API Reference AWS Security Token Service • 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 2011-06-15 48 AWS Security Token Service API Reference DecodeAuthorizationMessage Decodes additional information about the authorization status of a request from an encoded message returned in response to an AWS request. For example, if a user is not authorized to perform an operation that he or she has requested, the request returns a Client.UnauthorizedOperation
|
sts-api-018
|
sts-api.pdf
| 18 |
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 2011-06-15 48 AWS Security Token Service API Reference DecodeAuthorizationMessage Decodes additional information about the authorization status of a request from an encoded message returned in response to an AWS request. For example, if a user is not authorized to perform an operation that he or she has requested, the request returns a Client.UnauthorizedOperation response (an HTTP 403 response). Some AWS operations additionally return an encoded message that can provide details about this authorization failure. Note Only certain AWS operations return an encoded authorization message. The documentation for an individual operation indicates whether that operation returns an encoded message in addition to returning an HTTP code. The message is encoded because the details of the authorization status can contain privileged information that the user who requested the operation should not see. To decode an authorization status message, a user must be granted permissions through an IAM policy to request the DecodeAuthorizationMessage (sts:DecodeAuthorizationMessage) action. The decoded message includes the following type of information: • Whether the request was denied due to an explicit deny or due to the absence of an explicit allow. For more information, see Determining Whether a Request is Allowed or Denied in the IAM User Guide. • The principal who made the request. • The requested action. • The requested resource. • The values of condition keys in the context of the user's request. Request Parameters For information about the parameters that are common to all actions, see Common Parameters. DecodeAuthorizationMessage API Version 2011-06-15 49 AWS Security Token Service EncodedMessage API Reference The encoded message that was returned with the response. Type: String Length Constraints: Minimum length of 1. Maximum length of 10240. Required: Yes Response Elements The following element is returned by the service. DecodedMessage The API returns a response with the decoded message. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InvalidAuthorizationMessage The error returned if the message passed to DecodeAuthorizationMessage was invalid. This can happen if the token contains invalid characters, such as line breaks, or if the message has expired. HTTP Status Code: 400 Examples Example The following code provides an example of a DecodeAuthorizationMessage policy: { "Version": "2012-10-17", Response Elements API Version 2011-06-15 50 API Reference AWS Security Token Service "Statement": [ { "Sid": "decodepolicy", "Effect": "Allow", "Action": "sts:DecodeAuthorizationMessage", "Resource": "*" } ] } Example This example illustrates one usage of DecodeAuthorizationMessage. Sample Request POST https://sts.amazonaws.com / HTTP/1.1 Content-Type: application/x-www-form-urlencoded; charset=utf-8 Host: sts.amazonaws.com Content-Length: 1148 Expect: 100-continue Connection: Keep-Alive Action=DecodeAuthorizationMessage &EncodedMessage=<encoded-message> &Version=2011-06-15 &AUTHPARAMS Sample Response <?xml version="1.0" encoding="UTF-8"?> <DecodeAuthorizationMessageResponse xmlns="http://sts.amazonaws.com/doc/2011-06-15/"> <requestId>6624a9ca-cd25-4f50-b2a5-7ba65bf07453</requestId> <DecodedMessage> { "allowed": "false", "explicitDeny": "false", "matchedStatements": "", "failures": "", "context": { "principal": { "id": "AIDACKCEVSQ6C2EXAMPLE", "name": "Bob", "arn": "arn:aws:iam::123456789012:user/Bob" Examples API Version 2011-06-15 51 AWS Security Token Service }, API Reference "action": "ec2:StopInstances", "resource": "arn:aws:ec2:us-east-1:123456789012:instance/i-dd01c9bd", "conditions": [ { "item": { "key": "ec2:Tenancy", "values": ["default"] }, { "item": { "key": "ec2:ResourceTag/elasticbeanstalk:environment-name", "values": ["Default-Environment"] } }, (Additional items ...) ] } } </DecodedMessage> </DecodeAuthorizationMessageResponse> 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 2011-06-15 52 AWS Security Token Service GetAccessKeyInfo API Reference Returns the account identifier for the specified access key ID. Access keys consist of two parts: an access key ID (for example, AKIAIOSFODNN7EXAMPLE) and a secret access key (for example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). For more information about access keys, see Managing Access Keys for IAM Users in the IAM User Guide. When you pass an access key ID to this operation, it returns the ID of the AWS account to which the keys belong. Access key IDs beginning with AKIA are long-term credentials for an IAM user or the AWS account root user. Access key IDs beginning with ASIA are temporary credentials that are created using AWS STS operations. If the account in the response belongs to you, you can sign in as the root user and review your root user access keys. Then, you can pull a credentials report to learn which IAM user owns the keys. To learn who requested the temporary credentials for an ASIA access key, view the AWS STS events in your CloudTrail logs in the IAM User Guide. This operation does not
|
sts-api-019
|
sts-api.pdf
| 19 |
with AKIA are long-term credentials for an IAM user or the AWS account root user. Access key IDs beginning with ASIA are temporary credentials that are created using AWS STS operations. If the account in the response belongs to you, you can sign in as the root user and review your root user access keys. Then, you can pull a credentials report to learn which IAM user owns the keys. To learn who requested the temporary credentials for an ASIA access key, view the AWS STS events in your CloudTrail logs in the IAM User Guide. This operation does not indicate the state of the access key. The key might be active, inactive, or deleted. Active keys might not have permissions to perform an operation. Providing a deleted access key might return an error that the key doesn't exist. Request Parameters For information about the parameters that are common to all actions, see Common Parameters. AccessKeyId The identifier of an access key. This parameter allows (through its regex pattern) a string of characters that can consist of any upper- or lowercase letter or digit. Type: String Length Constraints: Minimum length of 16. Maximum length of 128. Pattern: [\w]* Required: Yes GetAccessKeyInfo API Version 2011-06-15 53 API Reference AWS Security Token Service Response Elements The following element is returned by the service. Account The number used to identify the AWS account. Type: String Errors For information about the errors that are common to all actions, see Common Errors. Examples Example This example illustrates one usage of GetAccessKeyInfo. Sample Request https://sts.amazonaws.com/ ?Version=2011-06-15 &Action=GetAccessKeyInfo &AccessKeyId=AKIAI44QH8DHBEXAMPLE &AUTHPARAMS Sample Response <GetAccessKeyInfoResponse xmlns="https://sts.amazonaws.com/doc/2011-06-15/"> <GetAccessKeyInfoResult> <Account>111122223333</Account> </GetAccessKeyInfoResult> <ResponseMetadata> <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId> </ResponseMetadata> </GetAccessKeyInfoResponse> Response Elements API Version 2011-06-15 54 AWS Security Token Service 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 2011-06-15 55 AWS Security Token Service GetCallerIdentity API Reference Returns details about the IAM user or role whose credentials are used to call the operation. Note No permissions are required to perform this operation. If an administrator attaches a policy to your identity that explicitly denies access to the sts:GetCallerIdentity action, you can still perform this operation. Permissions are not required because the same information is returned when access is denied. To view an example response, see I Am Not Authorized to Perform: iam:DeleteVirtualMFADevice in the IAM User Guide. Response Elements The following elements are returned by the service. Account The AWS account ID number of the account that owns or contains the calling entity. Type: String Arn The AWS ARN associated with the calling entity. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD \u10000-\u10FFFF]+ UserId The unique identifier of the calling entity. The exact value depends on the type of entity that is making the call. The values returned are those listed in the aws:userid column in the Principal table found on the Policy Variables reference page in the IAM User Guide. Type: String GetCallerIdentity API Version 2011-06-15 56 AWS Security Token Service Errors API Reference For information about the errors that are common to all actions, see Common Errors. Examples Example 1 - Called by an IAM user This example shows a request and response made with the credentials for a user named Alice in the AWS account 123456789012. Sample Request POST / HTTP/1.1 Host: sts.amazonaws.com Accept-Encoding: identity Content-Length: 32 Content-Type: application/x-www-form-urlencoded Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160126/us-east-1/sts/ aws4_request, SignedHeaders=host;user-agent;x-amz-date, Signature=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef X-Amz-Date: 20160126T215751Z User-Agent: aws-cli/1.10.0 Python/2.7.3 Linux/3.13.0-76-generic botocore/1.3.22 Action=GetCallerIdentity&Version=2011-06-15 Sample Response HTTP/1.1 200 OK x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef Content-Type: text/xml Content-Length: 357 Date: Tue, 26 Jan 2016 21:57:47 GMT <GetCallerIdentityResponse xmlns="https://sts.amazonaws.com/doc/2011-06-15/"> <GetCallerIdentityResult> <Arn>arn:aws:iam::123456789012:user/Alice</Arn> <UserId>AIDACKCEVSQ6C2EXAMPLE</UserId> <Account>123456789012</Account> </GetCallerIdentityResult> <ResponseMetadata> Errors API Version 2011-06-15 57 AWS Security Token Service API Reference <RequestId>01234567-89ab-cdef-0123-456789abcdef</RequestId> </ResponseMetadata> </GetCallerIdentityResponse> Example 2 - Called by user created with AssumeRole This example shows a request and response made with temporary credentials created by AssumeRole. The name of the assumed role is my-role-name, and the RoleSessionName is set to my-role-session-name. Sample Request POST / HTTP/1.1 Host: sts.amazonaws.com Accept-Encoding: identity Content-Length: 43 X-Amz-Date: 20160301T213302Z User-Agent: aws-cli/1.10.0 Python/2.7.3 Linux/3.13.0-79-generic botocore/1.3.22 X-Amz-Security-Token:<REDACTED> Content-Type: application/x-www-form-urlencoded Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160301/us-east-1/sts/ aws4_request, SignedHeaders=host;user-agent;x-amz-date;x-amz-security-token, Signature=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef Action=GetCallerIdentity&Version=2011-06-15 Sample Response HTTP/1.1 200 OK x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef Content-Type: text/xml Content-Length: 438 Date: Tue, 01 Mar 2016 21:32:59 GMT <GetCallerIdentityResponse xmlns="https://sts.amazonaws.com/doc/2011-06-15/"> <GetCallerIdentityResult> <Arn>arn:aws:sts::123456789012:assumed-role/my-role-name/my-role-session-name</Arn> <UserId>ARO123EXAMPLE123:my-role-session-name</UserId> <Account>123456789012</Account> </GetCallerIdentityResult> Examples API Version 2011-06-15 58 AWS Security Token Service <ResponseMetadata> <RequestId>01234567-89ab-cdef-0123-456789abcdef</RequestId> </ResponseMetadata> </GetCallerIdentityResponse> API Reference Example 3 - Called by user created with GetFederationToken This example shows a request and response
|
sts-api-020
|
sts-api.pdf
| 20 |
AssumeRole. The name of the assumed role is my-role-name, and the RoleSessionName is set to my-role-session-name. Sample Request POST / HTTP/1.1 Host: sts.amazonaws.com Accept-Encoding: identity Content-Length: 43 X-Amz-Date: 20160301T213302Z User-Agent: aws-cli/1.10.0 Python/2.7.3 Linux/3.13.0-79-generic botocore/1.3.22 X-Amz-Security-Token:<REDACTED> Content-Type: application/x-www-form-urlencoded Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160301/us-east-1/sts/ aws4_request, SignedHeaders=host;user-agent;x-amz-date;x-amz-security-token, Signature=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef Action=GetCallerIdentity&Version=2011-06-15 Sample Response HTTP/1.1 200 OK x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef Content-Type: text/xml Content-Length: 438 Date: Tue, 01 Mar 2016 21:32:59 GMT <GetCallerIdentityResponse xmlns="https://sts.amazonaws.com/doc/2011-06-15/"> <GetCallerIdentityResult> <Arn>arn:aws:sts::123456789012:assumed-role/my-role-name/my-role-session-name</Arn> <UserId>ARO123EXAMPLE123:my-role-session-name</UserId> <Account>123456789012</Account> </GetCallerIdentityResult> Examples API Version 2011-06-15 58 AWS Security Token Service <ResponseMetadata> <RequestId>01234567-89ab-cdef-0123-456789abcdef</RequestId> </ResponseMetadata> </GetCallerIdentityResponse> API Reference Example 3 - Called by user created with GetFederationToken This example shows a request and response made with temporary credentials created by using GetFederationToken. The Name parameter is set to my-federated-user-name. Sample Request POST / HTTP/1.1 Host: sts.amazonaws.com Accept-Encoding: identity Content-Length: 43 X-Amz-Date: 20160301T215108Z User-Agent: aws-cli/1.10.0 Python/2.7.3 Linux/3.13.0-79-generic botocore/1.3.22 X-Amz-Security-Token:<REDACTED> Content-Type: application/x-www-form-urlencoded Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160301/us-east-1/sts/ aws4_request, SignedHeaders=host;user-agent;x-amz-date;x-amz-security-token, Signature=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef Action=GetCallerIdentity&Version=2011-06-15 Sample Response HTTP/1.1 200 OK x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef Content-Type: text/xml Content-Length: 437 Date: Tue, 01 Mar 2016 21:51:06 GMT <GetCallerIdentityResponse xmlns="https://sts.amazonaws.com/doc/2011-06-15/"> <GetCallerIdentityResult> <Arn>arn:aws:sts::123456789012:federated-user/my-federated-user-name</Arn> <UserId>123456789012:my-federated-user-name</UserId> <Account>123456789012</Account> </GetCallerIdentityResult> <ResponseMetadata> Examples API Version 2011-06-15 59 AWS Security Token Service API Reference <RequestId>01234567-89ab-cdef-0123-456789abcdef</RequestId> </ResponseMetadata> </GetCallerIdentityResponse> 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 2011-06-15 60 AWS Security Token Service API Reference GetFederationToken Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a user. A typical use is in a proxy application that gets temporary security credentials on behalf of distributed applications inside a corporate network. You must call the GetFederationToken operation using the long-term security credentials of an IAM user. As a result, this call is appropriate in contexts where those credentials can be safeguarded, usually in a server-based application. For a comparison of GetFederationToken with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Compare AWS STS credentials in the IAM User Guide. Although it is possible to call GetFederationToken using the security credentials of an AWS account root user rather than an IAM user that you create for the purpose of a proxy application, we do not recommend it. For more information, see Safeguard your root user credentials and don't use them for everyday tasks in the IAM User Guide. Note You can create a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect- compatible identity provider. In this case, we recommend that you use Amazon Cognito or AssumeRoleWithWebIdentity. For more information, see Federation Through a Web- based Identity Provider in the IAM User Guide. Session duration The temporary credentials are valid for the specified duration, from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration is 43,200 seconds (12 hours). Temporary credentials obtained by using the root user credentials have a maximum duration of 3,600 seconds (1 hour). Permissions You can use the temporary credentials created by GetFederationToken in any AWS service with the following exceptions: • You cannot call any IAM operations using the AWS CLI or the AWS API. This limitation does not apply to console sessions. GetFederationToken API Version 2011-06-15 61 AWS Security Token Service API Reference • You cannot call any AWS STS operations except GetCallerIdentity. You can use temporary credentials for single sign-on (SSO) to the console. You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. Though the session policy parameters are optional, if you do not pass a policy, then the resulting federated user session has no permissions. When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide. For information about using GetFederationToken to create temporary security credentials, see GetFederationToken— Federation Through a Custom Identity Broker. You can use the
|
sts-api-021
|
sts-api.pdf
| 21 |
the resulting federated user session has no permissions. When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide. For information about using GetFederationToken to create temporary security credentials, see GetFederationToken— Federation Through a Custom Identity Broker. You can use the credentials to access a resource that has a resource-based policy. If that policy specifically references the federated user session in the Principal element of the policy, the session has the permissions allowed by the policy. These permissions are granted in addition to the permissions granted by the session policies. Tags (Optional) You can pass tag key-value pairs to your session. These are called session tags. For more information about session tags, see Passing Session Tags in AWS STS in the IAM User Guide. Note You can create a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect- compatible identity provider. In this case, we recommend that you use Amazon Cognito or AssumeRoleWithWebIdentity. For more information, see Federation Through a Web- based Identity Provider in the IAM User Guide. GetFederationToken API Version 2011-06-15 62 AWS Security Token Service API Reference An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access Control in the IAM User Guide. Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have separate Department and department tag keys. Assume that the user that you are federating has the Department=Marketing tag and you pass the department=engineering session tag. Department and department are not saved as separate tags, and the session tag passed in the request takes precedence over the user tag. Request Parameters For information about the parameters that are common to all actions, see Common Parameters. DurationSeconds The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions obtained using root user credentials are restricted to a maximum of 3,600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using root user credentials defaults to one hour. Type: Integer Valid Range: Minimum value of 900. Maximum value of 129600. Required: No Name The name of the federated user. The name is used as an identifier for the temporary security credentials (such as Bob). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy. The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- Type: String Length Constraints: Minimum length of 2. Maximum length of 32. Request Parameters API Version 2011-06-15 63 AWS Security Token Service Pattern: [\w+=,.@-]* Required: Yes Policy API Reference An IAM policy in JSON format that you want to use as an inline session policy. You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as managed session policies. This parameter is optional. However, if you do not pass any session policies, then the resulting federated user session has no permissions. When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide. The resulting credentials can be used to access a resource that has a resource-based policy. If that policy specifically references the federated user session in the Principal element of the policy, the session has the permissions allowed by the policy. These permissions are granted in addition to the permissions that are granted by the session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can
|
sts-api-022
|
sts-api.pdf
| 22 |
those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide. The resulting credentials can be used to access a resource that has a resource-based policy. If that policy specifically references the federated user session in the Principal element of the policy, the session has the permissions allowed by the policy. These permissions are granted in addition to the permissions that are granted by the session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\u0020 through \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters. Note An AWS conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit. Type: String Request Parameters API Version 2011-06-15 64 AWS Security Token Service API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+ Required: No PolicyArns.member.N The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a managed session policy. The policies must exist in the same account as the IAM user that is requesting federated access. You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. You can provide up to 10 managed policy ARNs. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. This parameter is optional. However, if you do not pass any session policies, then the resulting federated user session has no permissions. When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide. The resulting credentials can be used to access a resource that has a resource-based policy. If that policy specifically references the federated user session in the Principal element of the policy, the session has the permissions allowed by the policy. These permissions are granted in addition to the permissions that are granted by the session policies. Note An AWS conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit. Request Parameters API Version 2011-06-15 65 AWS Security Token Service API Reference Type: Array of PolicyDescriptorType objects Required: No Tags.member.N A list of session tags. Each session tag consists of a key name and an associated value. For more information about session tags, see Passing Session Tags in AWS STS in the IAM User Guide. This parameter is optional. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these and additional limits, see IAM and AWS STS Character Limits in the IAM User Guide. Note An AWS conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit. You can pass a session tag with the same key as a tag that is already attached to the user you are federating. When you do, session tags override a user tag with the same key. Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have separate Department and department tag keys. Assume that the role has the Department=Marketing tag and you pass the department=engineering session tag.
|
sts-api-023
|
sts-api.pdf
| 23 |
meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit. You can pass a session tag with the same key as a tag that is already attached to the user you are federating. When you do, session tags override a user tag with the same key. Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have separate Department and department tag keys. Assume that the role has the Department=Marketing tag and you pass the department=engineering session tag. Department and department are not saved as separate tags, and the session tag passed in the request takes precedence over the role tag. Type: Array of Tag objects Array Members: Maximum number of 50 items. Required: No Response Elements The following elements are returned by the service. Response Elements API Version 2011-06-15 66 AWS Security Token Service Credentials API Reference The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token. Note The size of the security token that AWS STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size. Type: Credentials object FederatedUser Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy. Type: FederatedUser object PackedPolicySize A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space. Type: Integer Valid Range: Minimum value of 0. Errors For information about the errors that are common to all actions, see Common Errors. MalformedPolicyDocument The request was rejected because the policy document was malformed. The error message describes the specific error. HTTP Status Code: 400 Errors API Version 2011-06-15 67 AWS Security Token Service PackedPolicyTooLarge API Reference The request was rejected because the total packed size of the session policies and session tags combined was too large. An AWS conversion compresses the session policy document, session policy ARNs, and session tags into a packed binary format that has a separate limit. The error message indicates by percentage how close the policies and tags are to the upper size limit. For more information, see Passing Session Tags in AWS STS in the IAM User Guide. You could receive this error even though you meet other defined session policy and session tag limits. For more information, see IAM and AWS STS Entity Character Limits in the IAM User Guide. HTTP Status Code: 400 RegionDisabled AWS STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate AWS STS in that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the IAM User Guide. HTTP Status Code: 403 Examples Example This example illustrates one usage of GetFederationToken. Sample Request https://sts.amazonaws.com/ ?Version=2011-06-15 &Action=GetFederationToken &Name=Bob &PolicyArns.member.1.arn=arn:aws:iam::123456789012:policy/federateduserdemopolicy1 &PolicyArns.member.2.arn=arn:aws:iam::123456789012:policy/federateduserdemopolicy2 &Policy=%7B%22Version%22%3A%222012-10-17%22%2C%22Statement%22%3A%5B%7B%22Sid%22%3A %22Stmt1%22%2C%22Effect%22% 3A%22Allow%22%2C%22Action%22%3A%22s3%3A*%22%2C%22Resource%22%3A%22*%22%7D %5D%7D &DurationSeconds=3600 Examples API Version 2011-06-15 68 AWS Security Token Service API Reference &Tags.member.1.Key=Dept&Tags.member.1.Value=Accounting &Tags.member.2.Key=Cost-Center&Tags.member.2.Value=12345 &AUTHPARAMS Sample Response <GetFederationTokenResponse xmlns="https://sts.amazonaws.com/doc/2011-06-15/"> <GetFederationTokenResult> <Credentials> <SessionToken> AQoDYXdzEPT//////////wEXAMPLEtc764bNrC9SAPBSM22wDOk4x4HIZ8j4FZTwdQW LWsKWHGBuFqwAeMicRXmxfpSPfIeoIYRqTflfKD8YUuwthAx7mSEI/qkPpKPi/kMcGd QrmGdeehM4IC1NtBmUpp2wUE8phUZampKsburEDy0KPkyQDYwT7WZ0wq5VSXDvp75YU 9HFvlRd8Tx6q6fE8YQcHNVXAkiY9q6d+xo0rKwT38xVqr7ZD0u0iPPkUL64lIZbqBAz +scqKmlzm8FDrypNC9Yjc8fPOLn9FX9KSYvKTr4rvx3iSIlTJabIQwj2ICCR/oLxBA== </SessionToken> <SecretAccessKey> wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY </SecretAccessKey> <Expiration>2011-07-15T23:28:33.359Z</Expiration> <AccessKeyId>ASIAIOSFODNN7EXAMPLE</AccessKeyId> </Credentials> <FederatedUser> <Arn>arn:aws:sts::123456789012:federated-user/Bob</Arn> <FederatedUserId>123456789012:Bob</FederatedUserId> </FederatedUser> <PackedPolicySize>6</PackedPolicySize> </GetFederationTokenResult> <ResponseMetadata> <RequestId>c6104cbe-af31-11e0-8154-cbc7ccf896c7</RequestId> </ResponseMetadata> </GetFederationTokenResponse> 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++ See Also API Version 2011-06-15 69 AWS Security Token Service • 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 API Reference See Also API Version 2011-06-15 70 AWS Security Token Service GetSessionToken API Reference Returns a set of temporary credentials for an AWS account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use GetSessionToken if you want to use MFA to protect programmatic calls to specific AWS API operations like Amazon EC2 StopInstances. MFA-enabled IAM users must call GetSessionToken and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that the call returns, IAM users can then make programmatic calls to API operations that require MFA authentication. An incorrect MFA code causes the API to return an access denied error. For a comparison of GetSessionToken with the other API operations that produce
|
sts-api-024
|
sts-api.pdf
| 24 |
access key ID, a secret access key, and a security token. Typically, you use GetSessionToken if you want to use MFA to protect programmatic calls to specific AWS API operations like Amazon EC2 StopInstances. MFA-enabled IAM users must call GetSessionToken and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that the call returns, IAM users can then make programmatic calls to API operations that require MFA authentication. An incorrect MFA code causes the API to return an access denied error. For a comparison of GetSessionToken with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Compare AWS STS credentials in the IAM User Guide. Note No permissions are required for users to perform this operation. The purpose of the sts:GetSessionToken operation is to authenticate the user using MFA. You cannot use policies to control authentication operations. For more information, see Permissions for GetSessionToken in the IAM User Guide. Session Duration The GetSessionToken operation must be called by using the long-term AWS security credentials of an IAM user. Credentials that are created by IAM users are valid for the duration that you specify. This duration can range from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), with a default of 43,200 seconds (12 hours). Credentials based on account credentials can range from 900 seconds (15 minutes) up to 3,600 seconds (1 hour), with a default of 1 hour. Permissions The temporary security credentials created by GetSessionToken can be used to make API calls to any AWS service with the following exceptions: • You cannot call any IAM API operations unless MFA authentication information is included in the request. • You cannot call any AWS STS API except AssumeRole or GetCallerIdentity. GetSessionToken API Version 2011-06-15 71 AWS Security Token Service API Reference The credentials that GetSessionToken returns are based on permissions associated with the IAM user whose credentials were used to call the operation. The temporary credentials have the same permissions as the IAM user. Note Although it is possible to call GetSessionToken using the security credentials of an AWS account root user rather than an IAM user, we do not recommend it. If GetSessionToken is called using root user credentials, the temporary credentials have root user permissions. For more information, see Safeguard your root user credentials and don't use them for everyday tasks in the IAM User Guide For more information about using GetSessionToken to create temporary credentials, see Temporary Credentials for Users in Untrusted Environments in the IAM User Guide. Request Parameters For information about the parameters that are common to all actions, see Common Parameters. DurationSeconds The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3,600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour. Type: Integer Valid Range: Minimum value of 900. Maximum value of 129600. Required: No SerialNumber The identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as Request Parameters API Version 2011-06-15 72 AWS Security Token Service API Reference arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials. The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/- Type: String Length Constraints: Minimum length of 9. Maximum length of 256. Pattern: [\w+=/:,.@-]* Required: No TokenCode The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, the user must provide a code when requesting a set of temporary security credentials. A user who fails to provide the code receives an "access denied" response when requesting resources that require MFA authentication. The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits. Type: String Length Constraints: Fixed length of 6. Pattern: [\d]* Required: No Response Elements The following element is returned by the service. Credentials The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
|
sts-api-025
|
sts-api.pdf
| 25 |
If MFA authentication is required, the user must provide a code when requesting a set of temporary security credentials. A user who fails to provide the code receives an "access denied" response when requesting resources that require MFA authentication. The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits. Type: String Length Constraints: Fixed length of 6. Pattern: [\d]* Required: No Response Elements The following element is returned by the service. Credentials The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token. Response Elements API Version 2011-06-15 73 AWS Security Token Service API Reference Note The size of the security token that AWS STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size. Type: Credentials object Errors For information about the errors that are common to all actions, see Common Errors. RegionDisabled AWS STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate AWS STS in that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the IAM User Guide. HTTP Status Code: 403 Examples Example This example illustrates one usage of GetSessionToken. Sample Request https://sts.amazonaws.com/ ?Version=2011-06-15 &Action=GetSessionToken &DurationSeconds=3600 &SerialNumber=YourMFADeviceSerialNumber &TokenCode=123456 &AUTHPARAMS Sample Response <GetSessionTokenResponse xmlns="https://sts.amazonaws.com/doc/2011-06-15/"> Errors API Version 2011-06-15 74 API Reference AWS Security Token Service <GetSessionTokenResult> <Credentials> <SessionToken> AQoEXAMPLEH4aoAH0gNCAPyJxz4BlCFFxWNE1OPTgk5TthT+FvwqnKwRcOIfrRh3c/L To6UDdyJwOOvEVPvLXCrrrUtdnniCEXAMPLE/IvU1dYUg2RVAJBanLiHb4IgRmpRV3z rkuWJOgQs8IZZaIv2BXIa2R4OlgkBN9bkUDNCJiBeb/AXlzBBko7b15fjrBs2+cTQtp Z3CYWFXG8C5zqx37wnOE49mRl/+OtkIKGO7fAE </SessionToken> <SecretAccessKey> wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY </SecretAccessKey> <Expiration>2011-07-11T19:55:29.611Z</Expiration> <AccessKeyId>ASIAIOSFODNN7EXAMPLE</AccessKeyId> </Credentials> </GetSessionTokenResult> <ResponseMetadata> <RequestId>58c5dbae-abef-11e0-8cfe-09039844ac7d</RequestId> </ResponseMetadata> </GetSessionTokenResponse> 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 2011-06-15 75 AWS Security Token Service Data Types API Reference The AWS Security Token Service 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: • AssumedRoleUser • Credentials • FederatedUser • PolicyDescriptorType • ProvidedContext • Tag API Version 2011-06-15 76 AWS Security Token Service AssumedRoleUser API Reference The identifiers for the temporary security credentials that the operation returns. Contents Arn The ARN of the temporary security credentials that are returned from the AssumeRole action. For more information about ARNs and how to use them in policies, see IAM Identifiers in the IAM User Guide. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD \u10000-\u10FFFF]+ Required: Yes AssumedRoleId A unique identifier that contains the role ID and the role session name of the role that is being assumed. The role ID is generated by AWS when the role is created. Type: String Length Constraints: Minimum length of 2. Maximum length of 193. Pattern: [\w+=,.@:-]* Required: Yes 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 AssumedRoleUser API Version 2011-06-15 77 AWS Security Token Service • AWS SDK for Ruby V3 API Reference See Also API Version 2011-06-15 78 API Reference AWS Security Token Service Credentials AWS credentials for API authentication. Contents AccessKeyId The access key ID that identifies the temporary security credentials. Type: String Length Constraints: Minimum length of 16. Maximum length of 128. Pattern: [\w]* Required: Yes Expiration The date on which the current credentials expire. Type: Timestamp Required: Yes SecretAccessKey The secret access key that can be used to sign requests. Type: String Required: Yes SessionToken The token that users must pass to the service API to use the temporary credentials. Type: String Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Credentials API Version 2011-06-15 79 AWS Security Token Service • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2011-06-15 80 AWS Security Token Service FederatedUser API Reference Identifiers for the federated user that is associated with the credentials. Contents Arn The ARN that specifies the federated user that is associated with the credentials. For more information about ARNs and how to use them in policies, see IAM Identifiers in the IAM User Guide. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048.
|
sts-api-026
|
sts-api.pdf
| 26 |
following: Credentials API Version 2011-06-15 79 AWS Security Token Service • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2011-06-15 80 AWS Security Token Service FederatedUser API Reference Identifiers for the federated user that is associated with the credentials. Contents Arn The ARN that specifies the federated user that is associated with the credentials. For more information about ARNs and how to use them in policies, see IAM Identifiers in the IAM User Guide. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD \u10000-\u10FFFF]+ Required: Yes FederatedUserId The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user. Type: String Length Constraints: Minimum length of 2. Maximum length of 193. Pattern: [\w+=,.@\:-]* Required: Yes 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 FederatedUser API Version 2011-06-15 81 AWS Security Token Service • AWS SDK for Ruby V3 API Reference See Also API Version 2011-06-15 82 AWS Security Token Service API Reference PolicyDescriptorType A reference to the IAM managed policy that is passed as a session policy for a role session or a federated user session. Contents arn The Amazon Resource Name (ARN) of the IAM managed policy to use as a session policy for the role. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD \u10000-\u10FFFF]+ Required: No 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 PolicyDescriptorType API Version 2011-06-15 83 AWS Security Token Service ProvidedContext API Reference Contains information about the provided context. This includes the signed and encrypted trusted context assertion and the context provider ARN from which the trusted context assertion was generated. Contents ContextAssertion The signed and encrypted trusted context assertion generated by the context provider. The trusted context assertion is signed and encrypted by AWS STS. Type: String Length Constraints: Minimum length of 4. Maximum length of 2048. Required: No ProviderArn The context provider ARN from which the trusted context assertion was generated. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD \u10000-\u10FFFF]+ Required: No 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 ProvidedContext API Version 2011-06-15 84 AWS Security Token Service API Reference See Also API Version 2011-06-15 85 AWS Security Token Service Tag API Reference You can pass custom key-value pair attributes when you assume a role or federate a user. These are called session tags. You can then use the session tags to control access to resources. For more information, see Tagging AWS STS Sessions in the IAM User Guide. Contents Key The key for a session tag. You can pass up to 50 session tags. The plain text session tag keys can’t exceed 128 characters. For these and additional limits, see IAM and AWS STS Character Limits in the IAM User Guide. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]+ Required: Yes Value The value for a session tag. You can pass up to 50 session tags. The plain text session tag values can’t exceed 256 characters. For these and additional limits, see IAM and AWS STS Character Limits in the IAM User Guide. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]* Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Tag API Version 2011-06-15 86 AWS Security Token Service • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2011-06-15 87 AWS Security Token Service 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.
|
sts-api-027
|
sts-api.pdf
| 27 |
Version 2011-06-15 87 AWS Security Token Service 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 2011-06-15 88 AWS Security Token Service 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 2011-06-15 89 AWS Security Token Service 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 2011-06-15 90 AWS Security Token Service 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 2011-06-15 91 AWS Security Token Service 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 2011-06-15 92
|
student-userguide-001
|
student-userguide.pdf
| 1 |
User Guide AWS DeepRacer Student Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. AWS DeepRacer Student User Guide AWS DeepRacer Student: 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 DeepRacer Student Table of Contents User Guide What is AWS DeepRacer Student? .................................................................................................. 1 Are you interested in the AWS AI & ML Scholarship program? .......................................................... 2 Are you a first-time AWS DeepRacer Student user? ............................................................................. 2 Are you interested in competing in the AWS DeepRacer Student League? ...................................... 2 What is the AWS AI & ML Scholarship program? .......................................................................... 3 What you win in the AWS AI & ML Scholarship .................................................................................... 3 How do I sign up and prequalify for the AWS AI & ML Scholarship program? ................................ 4 Frequently asked questions (FAQs) about the AWS AI & ML Scholarship program and the Udacity platform .......................................................................................................................................... 5 What are AWS Player accounts? ..................................................................................................... 8 Creating an AWS Player account for supported services ..................................................................... 8 Deleting an AWS Player account ............................................................................................................... 8 Getting started .............................................................................................................................. 10 Prerequisites ................................................................................................................................................ 10 Step 1: Sign up for AWS DeepRacer Student ....................................................................................... 10 Step 2: Complete sign-up for AWS DeepRacer Student .................................................................... 11 Step 3: (Optional) Read about and opt in to AWS AI & ML Scholarship consideration ................ 12 Step 4: Update your profile ..................................................................................................................... 12 Step 5: Explore AWS DeepRacer Student from the Home page ...................................................... 13 Train a reinforcement learning model ......................................................................................... 15 Step 1: Train a reinforcement learning model using AWS DeepRacer Student ............................. 15 Step 2: Name your model ........................................................................................................................ 15 Step 3: Choose your track ........................................................................................................................ 16 Step 4: Choose an algorithm ................................................................................................................... 16 Step 5: Customize your reward function .............................................................................................. 17 Step 6: Choose duration and submit your model to the leaderboard ............................................. 18 Step 7: View your model's performance on the leaderboard ........................................................... 19 Step 8: Use Clone to improve your model ........................................................................................... 19 Step 9: (Optional) Download a model ................................................................................................... 20 Join a race ...................................................................................................................................... 21 Join a student league race ....................................................................................................................... 21 Join a student community race .............................................................................................................. 22 Customize a reward function ........................................................................................................ 23 Editing Python code to customize your reward function .................................................................. 23 iii AWS DeepRacer Student User Guide Reward function input parameters ........................................................................................................ 24 all_wheels_on_track ............................................................................................................................. 25 closest_waypoints ................................................................................................................................. 27 closest_objects ....................................................................................................................................... 28 distance_from_center ........................................................................................................................... 29 heading .................................................................................................................................................... 30 is_crashed ............................................................................................................................................... 31 is_left_of_center .................................................................................................................................... 31 is_offtrack ............................................................................................................................................... 31 is_reversed .............................................................................................................................................. 31 objects_distance .................................................................................................................................... 31 objects_heading ..................................................................................................................................... 32 objects_left_of_center .......................................................................................................................... 32 objects_location ..................................................................................................................................... 32 objects_speed ........................................................................................................................................ 33 progress ................................................................................................................................................... 33 speed ....................................................................................................................................................... 33 steering_angle ....................................................................................................................................... 34 steps ......................................................................................................................................................... 36 track_length ........................................................................................................................................... 36 track_width ............................................................................................................................................. 37 x, y ............................................................................................................................................................ 38 waypoints ................................................................................................................................................ 39 Security .......................................................................................................................................... 40 Data protection ........................................................................................................................................... 40 Captured data in the AWS DeepRacer Student portal .................................................................. 41 Encryption at rest in AWS DeepRacer Student portal ................................................................... 41 Encryption in transit in AWS DeepRacer Student portal .............................................................. 42 Identity and access management ........................................................................................................... 42 Compliance validation ............................................................................................................................... 42 Resilience ...................................................................................................................................................... 43 Infrastructure security ............................................................................................................................... 43 Troubleshooting common issues .................................................................................................. 44 Why was I automatically signed out of my AWS DeepRacer Student account? ............................. 44 How do I opt out of the AWS AI & ML Scholarship program? .......................................................... 44 I can't delete my AWS DeepRacer Student account ........................................................................... 45 iv AWS DeepRacer Student User Guide I can't find my school name on the dropdown list ............................................................................. 45 I can't continue training my model ........................................................................................................ 45 I get an "An account is registered with this email" error message ................................................... 45 I signed up with a Gmail account and can't find my verification code ............................................ 46 Quotas ............................................................................................................................................ 47 Account deletion ............................................................................................................................ 48 Document history .......................................................................................................................... 50 v AWS DeepRacer Student User Guide What is AWS DeepRacer Student? AWS DeepRacer Student is a place for high school and college-enrolled learners around the globe to develop machine learning (ML) skills. It provides access to educational material, the optional AWS AI & ML Scholarship program, and the opportunity to train and test reinforcement learning (RL) models for the AWS DeepRacer Student League. To get started, see the topics in the ??? section. AWS DeepRacer Student features • Home – Find details about upcoming events, practice training RL models, access ML educational content, and track your model training hours. You can also manage your AWS DeepRacer Student profile and account info from the left navigation pane. • Learn – Access ML content, including videos, developed by
|
student-userguide-002
|
student-userguide.pdf
| 2 |
to develop machine learning (ML) skills. It provides access to educational material, the optional AWS AI & ML Scholarship program, and the opportunity to train and test reinforcement learning (RL) models for the AWS DeepRacer Student League. To get started, see the topics in the ??? section. AWS DeepRacer Student features • Home – Find details about upcoming events, practice training RL models, access ML educational content, and track your model training hours. You can also manage your AWS DeepRacer Student profile and account info from the left navigation pane. • Learn – Access ML content, including videos, developed by AWS experts. Students with no prior experience can learn ML fundamentals from easy-to-understand, self-paced material. • Practice – Choose a track, algorithm, and reward function to create a RL model. Optionally, take a guided walkthrough of the reward function Python code and choose to customize it. Train your model in a simulated 3D racing environment using the AWS DeepRacer service. Clone your top- performing models and iterate on their reward functions to climb the AWS DeepRacer Student League leaderboard. • Compete – Submit your models to monthly virtual races to earn achievements and the opportunity to win prizes. The top regional student racers earn the opportunity to compete in the Student World Championships. For more information, refer to the terms and conditions. All students have 10 hours every month to train RL models for the AWS DeepRacer Student League. Only models trained using AWS DeepRacer Student can be used in the AWS DeepRacer Student League. Topics • Are you interested in the AWS AI & ML Scholarship program? • Are you a first-time AWS DeepRacer Student user? • Are you interested in competing in the AWS DeepRacer Student League? 1 AWS DeepRacer Student User Guide Are you interested in the AWS AI & ML Scholarship program? If you self-identify as underserved or underrepresented in technology, opt into the AWS AI & ML Scholarship program. To learn more about who qualifies, how to apply, and what you win, see What is the AWS AI & ML Scholarship program? Are you a first-time AWS DeepRacer Student user? If you are a first-time user of AWS DeepRacer Student, we recommend that you begin by reading the following sections: • Getting started with AWS DeepRacer Student • Join an AWS DeepRacer Student race • Training a reinforcement learning model in AWS DeepRacer Student Are you interested in competing in the AWS DeepRacer Student League? The AWS DeepRacer Student League is an AWS-sponsored competition where students can compete in monthly virtual races between March and September to compete at the national and regional level and qualify for the opportunity to compete in the Student World Championships in October. Students have the opportunity to earn rewards and prizes. For more information, see the terms and conditions. To compete in your first race, see Join an AWS DeepRacer Student race. Are you interested in the AWS AI & ML Scholarship program? 2 AWS DeepRacer Student User Guide What is the AWS AI & ML Scholarship program? Launching as part of AWS DeepRacer Student, the AWS AI & ML Scholarship program is designed to bring diversity to the field of artificial intelligence (AI) and machine learning (ML) by offering successful applicants the opportunity to earn up to two Udacity Nanodegrees. The Udacity Nanodegree is massive open online courses (MOOCs) designed to bridge the gap between learning and career goals. For more details, see What is a Nanodegree Program? in the Udacity support documentation. Successful applicants will also have access to exclusive events and mentoring to help them further their careers. For more details see, What you win in the AWS AI & ML Scholarship. This scholarship is focused on people who are underserved and underrepresented in tech. Applicants must be at least 16 years old, and currently enrolled in high school, university, or community colleges. For more details about how you prequalify, see How do I sign up and prequalify for the AWS AI & ML Scholarship program? Participation in the AWS AI & ML Scholarship program is free. The AWS AI & ML Scholarship program officially launched on April 11, 2022. The AWS AI & ML Scholarship program works on a cohort-based approach. Each year, two cohorts of 1,000 students are selected (2,000 total). The applications for the first cohort are due to Udacity on May 31, 2024, and the applications for the second cohort are due on September 30, 2024. What you win in the AWS AI & ML Scholarship For the AWS AI & ML Scholarship program, AWS is collaborating with Udacity. Each year, the AWS AI & ML Scholarship program will globally offer 2,500 Udacity Nanodegree scholarships spread across two different cohorts. All students receive the following: • Free admission to the AI Programming
|
student-userguide-003
|
student-userguide.pdf
| 3 |
program works on a cohort-based approach. Each year, two cohorts of 1,000 students are selected (2,000 total). The applications for the first cohort are due to Udacity on May 31, 2024, and the applications for the second cohort are due on September 30, 2024. What you win in the AWS AI & ML Scholarship For the AWS AI & ML Scholarship program, AWS is collaborating with Udacity. Each year, the AWS AI & ML Scholarship program will globally offer 2,500 Udacity Nanodegree scholarships spread across two different cohorts. All students receive the following: • Free admission to the AI Programming with Python Nanodegree. This course teaches the foundational skills necessary to start using AI techniques and develop your skills in programming, linear algebra, and neural networks. • Access to office hours with Udacity instructors during the week to help answer questions about class content. Also, students can participate in weekly case study exercises lead by Udacity instructors. What you win in the AWS AI & ML Scholarship 3 AWS DeepRacer Student User Guide • Exclusive access to mentorship and career resources including sessions from industry experts, resume editing guidance, and interviewing tips. Also, the top 500 students from the AI Programming with Python class (based on performance in course assessments) are given access to a more advanced Nanodegree that covers the fundamentals of deep learning, and provides you with skills required to be a machine learning engineer. All students who complete the scholarship prerequisites and submit a Udacity application receive free access to a new generative AI course, Introducing Generative AI with AWS, co-created by AWS and Udacity. The month-long course is an optional resource to help students further upskill in the field of generative AI. The course is available to all students who submit an application for the scholarship, whereas the Nanodegree scholarship is only available to scholarship recipients. How do I sign up and prequalify for the AWS AI & ML Scholarship program? The AWS AI & ML Scholarship program is intended for underserved and underrepresented students who are 16 years or older. Underrepresented and underserved students include (but are not limited to) women, people with disabilities, people of color (Black, Latinx, and Indigenous), and members of the LGBTQ+ community. To begin, students need to sign up and create an account on AWS DeepRacer Student. At sign up, you opt into the AWS AI & ML Scholarship program by checking the checkbox. When your account is set up, you see a tile on the Home page for tracking your scholarship application prequalification tasks. Students need to complete two prerequisites in AWS DeepRacer Student to submit their application for the scholarship program. Students who prequalify for the AWS AI & ML Scholarship receive a unique access code they can redeem on the Udacity site to access the Udacity Nanodegree scholarship application form. Students who prequalify are not guaranteed Udacity Nanodegree scholarships. Udacity determines which prequalified students are awarded Udacity Nanodegree scholarships. Prequalifying for the scholarship is based on two criteria: Review coursework and pass assessments How do I sign up and prequalify for the AWS AI & ML Scholarship program? 4 AWS DeepRacer Student User Guide To prequalify, you must score 80% or higher on all required assessments. Each assessment is based on different chapters you can find in the Learn section in the AWS DeepRacer Student navigation pane. The scholarship application opens on February 1, 2024. Achieve a minimum lap time Each month from February to September, a new leaderboard is launched in the AWS DeepRacer League, featuring a new track. To prequalify for the scholarship, you will need to achieve a sub-two minute single lap time in any single race. After students complete both prerequisites, they receive an email from AWS with a unique access code and a link to the application for the Udacity Nanodegree scholarship. To be considered for the scholarship, students need to fill out the application in its entirety. When the application is complete, Udacity contacts students with steps to enroll in the optional Introducing Generative AI with AWS course offered to all applicants. Udacity contacts applicants who are selected to receive a Udacity Nanodegree scholarship. Frequently asked questions (FAQs) about the AWS AI & ML Scholarship program and the Udacity platform What are the official AWS AI & ML Scholarship terms and conditions? To view the official terms and conditions, see Official AWS AI & ML Scholarship program Terms and Conditions. Who is this scholarship for? This AWS AI & ML Scholarship program is intended for underserved and underrepresented students around the world who are 16 years or older. Underrepresented and underserved students include (but are not limited to) women, people with disabilities, people of color (Black, Latinx, and Indigenous), and members of the LGBTQ+ community. What is a nanodegree? A nanodegree
|
student-userguide-004
|
student-userguide.pdf
| 4 |
AI & ML Scholarship program and the Udacity platform What are the official AWS AI & ML Scholarship terms and conditions? To view the official terms and conditions, see Official AWS AI & ML Scholarship program Terms and Conditions. Who is this scholarship for? This AWS AI & ML Scholarship program is intended for underserved and underrepresented students around the world who are 16 years or older. Underrepresented and underserved students include (but are not limited to) women, people with disabilities, people of color (Black, Latinx, and Indigenous), and members of the LGBTQ+ community. What is a nanodegree? A nanodegree is an online skills-based educational program that helps to bridge the gap between learning and career skills. If I prequalify for the AWS AI & ML Scholarship, do I automatically receive a Udacity Nanodegree scholarship? Frequently asked questions (FAQs) about the AWS AI & ML Scholarship program and the Udacity platform 5 AWS DeepRacer Student User Guide No. Students who prequalify for the AWS AI & ML Scholarship are given access to the application for the Udacity Nanodegree scholarship. Udacity determines which prequalified students are awarded Udacity Nanodegree scholarships. Am I required to provide proof of enrollment before being selected for the AWS AI & ML Scholarship? You might be asked to provide proof of enrollment (such as a college transcript) to receive the AWS AI & ML Scholarship. How do I indicate that I am currently enrolled in high school when applying for the AWS AI & ML Scholarship program? To indicate that you are enrolled in high school, see Step 4: Update your profile in the AWS DeepRacer Student User Guide. How is my personally identifiable information (PII) data protected? Your data is secured in the AWS cloud. For more information, see the AWS privacy notice. Is there an age requirement in order to apply for the AWS AI & ML Scholarship? Yes. To apply for the AWS AI & ML Scholarship program, you must be at least 16 years old when you sign up. How will I be notified if I receive the AWS AI & ML Scholarship? You will receive an email from Udacity regarding the status of your nanodegree scholarship application after the deadline for applications has passed. When will I be notified if I receive the AWS AI & ML Scholarship? Udacity will contact applicants about their scholarship status. Students who are selected for a scholarship will be provided with information about important dates. How do I get access to the AWS generative AI course on Udacity? Students need to prequalify on AWS DeepRacer Student and submit a scholarship application on Udacity. Udacity contacts students after they have submitted complete applications and provides them with the steps for enrolling in the Introducing Generative AI with AWS course. What happens if I am accepted into the AWS AI & ML Scholarship program? Frequently asked questions (FAQs) about the AWS AI & ML Scholarship program and the Udacity platform 6 AWS DeepRacer Student User Guide After being notified that you have received the AWS AI & ML Scholarship, a representative from the Udacity onboarding team will contact you using the email that you provided to Udacity when you completed your application. If I receive a Udacity Nanodegree scholarship, how much time should I expect to spend on my nanodegree studies? Students should expect to spend approximately 10 hours per week on their Udacity nanodegree studies. Is English language proficiency required? Although English proficiency is not required, learning materials are in English. To be successful, students should have good reading and writing skills in English. What if I don’t find the options I identify with in the race/gender list? For both, you can use the option I prefer to self identify (Select to type). Frequently asked questions (FAQs) about the AWS AI & ML Scholarship program and the Udacity platform 7 AWS DeepRacer Student User Guide What are AWS Player accounts? AWS Player accounts are a managed identity solution for AWS DeepRacer multi-user and AWS DeepRacer Student created by AWS. Your AWS Player account holds all of the resources created in each of these AWS services. Creating an AWS Player account for supported services When you create an account for either AWS DeepRacer multi-user or AWS DeepRacer Student you automatically create an AWS Player account. When you use different features in these services, new resources are added automatically into your AWS Player account. To get started with AWS DeepRacer multi-user and AWS DeepRacer Student, use the following links. Creating an AWS DeepRacer Student account To use AWS DeepRacer Student, get started by creating an account. To learn how to create an account see, Step 1: Sign up for AWS DeepRacer Student in the AWS DeepRacer Student User Guide. Use AWS DeepRacer multi-user to sponsor multiple participants under
|
student-userguide-005
|
student-userguide.pdf
| 5 |
an account for either AWS DeepRacer multi-user or AWS DeepRacer Student you automatically create an AWS Player account. When you use different features in these services, new resources are added automatically into your AWS Player account. To get started with AWS DeepRacer multi-user and AWS DeepRacer Student, use the following links. Creating an AWS DeepRacer Student account To use AWS DeepRacer Student, get started by creating an account. To learn how to create an account see, Step 1: Sign up for AWS DeepRacer Student in the AWS DeepRacer Student User Guide. Use AWS DeepRacer multi-user to sponsor multiple participants under one account. AWS DeepRacer multi-user mode supports two different user profiles, admin and participant. Both have different setup requirements. To get started, see Multi-user Mode in the AWS DeepRacer Developer Guide. Deleting an AWS Player account If you delete an AWS Player account, you immediately lose access to all supported services. This includes any achievements (badges, points, avatars, etc) that you earned. Deleting your AWS Player account account does not delete your AWS account. If you would also like to delete your AWS account, use the steps outlined in Closing your AWS account. If you have used your AWS Player account account to create an event in AWS DeepRacer multi-user you cannot delete your AWS Player account account. This is to ensure that participants in events you have created are not left with a broken experience. To learn more about how an admin creates events in AWS DeepRacer multi-user mode, use the following topic. Setting up events using AWS DeepRacer multi-user mode (admin) Creating an AWS Player account for supported services 8 AWS DeepRacer Student User Guide To learn how to create events using multi-user mode, see Set up multi-user mode (admin) in the AWS DeepRacer Developer Guide. AWS Player accounts do not have access to any AWS resources other than those created in the service's account. Any AWS Identity and Access Management policies and associated resources in the service account are limited to only the required resources. Deleting an AWS Player account 9 AWS DeepRacer Student User Guide Getting started with AWS DeepRacer Student Use this tutorial to get started with AWS DeepRacer Student. The tutorial explains how to log in to AWS DeepRacer Student, update your profile, opt in to consideration for the AWS AI & ML Scholarship, start taking free courses in machine learning (ML) and reinforcement learning (RL), and create AWS DeepRacer models. If you don't opt in to the scholarship during account creation, you can opt in at a later time when you update your profile. Topics • Prerequisites • Step 1: Sign up for AWS DeepRacer Student • Step 2: Complete sign-up for AWS DeepRacer Student • Step 3: (Optional) Read about and opt in to AWS AI & ML Scholarship consideration • Step 4: Update your profile • Step 5: Explore AWS DeepRacer Student from the Home page Prerequisites To access AWS DeepRacer Student and participate, you need: • To be a student who is at least 16 years old and currently enrolled in a high school, community college, or college. • Or be an educator or event organizer for students in high school, university, or community college. • A valid email address. Step 1: Sign up for AWS DeepRacer Student You can sign up for AWS DeepRacer Student by using the URL provided in this procedure. When you sign up, you create an AWS Player account. This account can be used with certain other AWS services. If you already have an AWS Player account, you can use that account with AWS DeepRacer Student. 1. Open the http://deepracerstudent.com/ landing page. Prerequisites 10 AWS DeepRacer Student 2. Choose Get started. User Guide 3. On the Sign in page, if you don't already have an AWS Player account, choose Sign up. Note If you already have an AWS Player account, enter your information here. For more information about the AWS Player account, see What are AWS Player accounts? 4. On the Sign up page, enter the following information: • Email address • Password 5. Choose Sign up. An email with a confirmation code is sent to the email address you specified. 6. In the pop-up that appears, enter your verification number and choose Verify. 7. On the AWS DeepRacer Student Sign in page, enter your Email address and Password and choose Sign in. 8. On the Welcome to the AWS DeepRacer Student pop-up, choose Complete sign-up. Note You can choose I will do this later. Sign out for now if you want to sign up at a later time. Step 2: Complete sign-up for AWS DeepRacer Student Complete the section to create your AWS DeepRacer Student account. All fields are required unless otherwise stated. 1. Fill in the fields in the Add your personal information
|
student-userguide-006
|
student-userguide.pdf
| 6 |
that appears, enter your verification number and choose Verify. 7. On the AWS DeepRacer Student Sign in page, enter your Email address and Password and choose Sign in. 8. On the Welcome to the AWS DeepRacer Student pop-up, choose Complete sign-up. Note You can choose I will do this later. Sign out for now if you want to sign up at a later time. Step 2: Complete sign-up for AWS DeepRacer Student Complete the section to create your AWS DeepRacer Student account. All fields are required unless otherwise stated. 1. Fill in the fields in the Add your personal information to create your AWS DeepRacer Student account section to create your account. 2. Select the checkbox to certify that you are a student enrolled in either high school or a university or community college. Note If you are a high school student, do the following: Step 2: Complete sign-up for AWS DeepRacer Student 11 AWS DeepRacer Student User Guide • For School, choose Other. Then, add the name of your high school to the field Enter the name of your school. • For Current or prospective major, choose Undecided or choose a possible prospective major from the list. Step 3: (Optional) Read about and opt in to AWS AI & ML Scholarship consideration Read the information about the AWS AI & ML Scholarship and for whom it is intended in the Do you want to be considered for the AWS AI & ML Scholarship program? section. 1. If you meet the criteria for the AWS AI & ML Scholarship, you can opt in to be considered. Choose the checkbox to confirm that you want to be considered for a scholarship. Note If you don't want to be considered for a scholarship or are undecided, leave the checkbox unselected and choose either I will do this later. Sign out for now. to sign out for now, or Submit to continue without opting in. You can also opt in when you update your profile. 2. (Optional) Use the dropdown lists to enter your information in the Choose gender and Choose race (US participants only) fields. 3. Choose Submit. Step 4: Update your profile To update your profile, use the Your profile page. You can also choose to opt in to the AWS AI & ML Scholarship program. If you receive achievements for your performance in AWS DeepRacer Student League, you can share them on social media from the Your profile page. To update your profile 1. In AWS DeepRacer Student, in the left navigation pane, choose Your profile. 2. On the Your profile page, in Racer name, choose Change your racer name. Step 3: (Optional) Read about and opt in to AWS AI & ML Scholarship consideration 12 AWS DeepRacer Student Note User Guide Your racer name can have between 2 and 24 characters. Letters, numbers, and hyphen (-) are allowed. 3. In the Racer name modal, enter your racer name and choose Save. If you decide that you don't want to change your racer name, choose Cancel. 4. In the Your profile information section, you can make changes to the following fields: • Name • Racer name • School name • Name of major • Year of graduation • Country of residency Note Selecting a country of residence is required so that you can enter AWS DeepRacer Student League virtual races and receive prizes. Once you submit your model to a race, your country of residence is locked in for the racing season. 5. (Optional) In the Do you want to be considered for the AWS AI & ML Scholarship program? section, you can view information about the scholarship and how to apply. a. b. c. Select the checkbox to opt in for consideration in the scholarship program. (Optional) Enter your information in the Choose gender and Choose race fields. Choose Submit. Step 5: Explore AWS DeepRacer Student from the Home page The AWS DeepRacer Student Home page is the perfect place to start your exploration of all that AWS DeepRacer Student has to offer. From the Home page, you can do the following: Get started learning the fundamentals of machine learning (ML) Step 5: Explore AWS DeepRacer Student from the Home page 13 AWS DeepRacer Student User Guide You can use the free courses available in the Learn section of AWS DeepRacer Student. This robust offering helps you build a foundation for your machine learning journey with AWS DeepRacer Student. Practice using your machine learning knowledge After spending some time using the Learn courses, you're ready to create and train an AWS DeepRacer model. For more information, see Training a reinforcement learning model in AWS DeepRacer Student. Compete in AWS DeepRacer Student races When you've finished training your first AWS DeepRacer model, you're ready to join a race. If you're
|
student-userguide-007
|
student-userguide.pdf
| 7 |
Home page 13 AWS DeepRacer Student User Guide You can use the free courses available in the Learn section of AWS DeepRacer Student. This robust offering helps you build a foundation for your machine learning journey with AWS DeepRacer Student. Practice using your machine learning knowledge After spending some time using the Learn courses, you're ready to create and train an AWS DeepRacer model. For more information, see Training a reinforcement learning model in AWS DeepRacer Student. Compete in AWS DeepRacer Student races When you've finished training your first AWS DeepRacer model, you're ready to join a race. If you're racing in a student league monthly race, go to the Open races section and choose Enter race. When you've completed racing, check how your model did on the leaderboard along with data you need to make changes and improve your model. You earn points when you compete in monthly virtual races. These points determine your national and regional season standings. The top 3 racers for each month earn medals and prizes. For more information, see Join an AWS DeepRacer Student race. Check model training hours When you train and clone models, you use a portion of your free model training time. You can check on your model training hours remaining on the home page. Check the AWS DeepRacer Student racing calendar View the racing calendar and start planning for your race day. Learn about the AWS AI & ML Scholarship You can find out about the AWS AI & ML Scholarship and what you can do to prepare. For more information, see What is the AWS AI & ML Scholarship program? View other resources You can discover other resources that can help you on your exploration of AWS DeepRacer Student, such as the Discord channel and AWS DeepRacer website. These resources help connect you to a community of racers and fans sharing tips and insights. Step 5: Explore AWS DeepRacer Student from the Home page 14 AWS DeepRacer Student User Guide Training a reinforcement learning model in AWS DeepRacer Student This walkthrough demonstrates how to train your first model in AWS DeepRacer Student. It also provides you with some useful tips to help you make the most of your experience and fast-track your learning. Step 1: Train a reinforcement learning model using AWS DeepRacer Student Begin your journey in AWS DeepRacer Student by learning where to find the Create model button and start training your first model. Keep in mind that creating and training a model is an iterative process. Experiment with different algorithms and reward functions to achieve your best results. To train a reinforcement learning model 1. 2. In the AWS DeepRacer Student Home page, choose Create a model. Alternatively, navigate to Your Models in the left navigation pane. In the Models page, in Your models, choose Create model. In the Overview page, read about how to train a reinforcement model. Each step in the process is explained on this page. When you've finished reading, choose Next. Step 2: Name your model Name your model. It's good practice to give your models unique names to quickly locate individual models when you want to improve and clone them. For example, you may want to name your models using a naming convention such as: yourinitials-date-version. To name your model 1. On the Name your model page, enter a name in the Model name field. Step 1: Train a reinforcement learning model using AWS DeepRacer Student 15 AWS DeepRacer Student Note User Guide When you begin training a model, the model's name becomes fixed and is no longer changeable. 2. Choose Next. Step 3: Choose your track Choose your simulation track. The track serves as the environment and provides data to your car. If you choose a very complex track, your car requires a longer total training time and the reward function you use is more complex. To choose your track (environment) 1. On the Choose track page, choose a track to serve as a training environment for your car. 2. Choose Next. Step 4: Choose an algorithm The AWS DeepRacer Student has two training algorithms from which to choose. Different algorithms maximize rewards in different ways. To make the most of your AWS DeepRacer Student experience, experiment with both algorithms. For more information about algorithms, see AWS DeepRacer Training Algorithms. To choose a training algorithm 1. On the Choose algorithm type page, select an algorithm type. Two algorithm types are available: • Proximal Policy Optimization (PPO). This stable but data hungry algorithm performs consistently between training iterations. • Soft Actor Critic (SAC). This unstable but data efficient algorithm can perform inconsistently between training iterations. 2. Choose Next. Step 3: Choose your track 16 AWS DeepRacer Student User Guide Step 5: Customize your reward function The reward function is at the
|
student-userguide-008
|
student-userguide.pdf
| 8 |
of your AWS DeepRacer Student experience, experiment with both algorithms. For more information about algorithms, see AWS DeepRacer Training Algorithms. To choose a training algorithm 1. On the Choose algorithm type page, select an algorithm type. Two algorithm types are available: • Proximal Policy Optimization (PPO). This stable but data hungry algorithm performs consistently between training iterations. • Soft Actor Critic (SAC). This unstable but data efficient algorithm can perform inconsistently between training iterations. 2. Choose Next. Step 3: Choose your track 16 AWS DeepRacer Student User Guide Step 5: Customize your reward function The reward function is at the core of reinforcement learning. Use it to incentivize your car (agent) to take specific actions as it explores the track (environment). Just as you would encourage and discourage certain behaviors in a pet, you can use this tool to encourage your car to finish a lap as fast as possible and discourage it from driving off of the track and zig-zagging. When training your first model, you may want to use a default sample reward function. When you're ready to experiment and optimize your model, you can customize the reward function by editing the code in the code editor. For more information about customizing the reward function, see Customizing a reward function. To customize your reward function 1. On the Customize reward function page, choose a sample reward function. There are 3 sample reward functions available that you can customize: • Follow the centerline. Rewards your car when it autonomously drives as close as it can to the centerline of the track. • Stay within borders. Rewards your car when it autonomously drives with all four wheels staying within the track borders. • Prevent zig-zag. Rewards your car for staying near the centerline. Penalizes your car if it uses high steering angles or goes off track. Note If you don't want to customize the reward function, choose Next. 2. (Optional) Modify the reward function code. • • Select a sample reward function and choose Walk me through this code. For each section of the code, you can view more information by selecting the + to reveal a pop-up textbox with explantory text. Progress through the code walkthrough by choosing Next in each pop-up. To exit out of a pop-up textbox, choose the X in the corner. To exit the walkthrough, choose Finish. Step 5: Customize your reward function 17 AWS DeepRacer Student User Guide Note You can choose not to edit the sample reward function code by selecting Go with default code. • Optionally, edit the sample reward function code by selecting a sample reward function and choosing Edit sample code. Edit the code and select Validate to check your code. If your code can't be validated or you would like to reset the code to its original state, choose Reset. 3. Choose Next. Step 6: Choose duration and submit your model to the leaderboard The duration of your model's training impacts its performance. When experimenting in the early phase of training, you should start with a small value for this parameter and then progressively train for longer periods of time. In this step of training your model, your trained model is submitted to a leaderboard. You can opt out by deselecting the checkbox. To choose duration and submit a model to the leaderboard 1. On the Choose duration page, select a time in Choose duration of model training. 2. In the Model description field, enter a useful description for your model that will help you to remember the selections you made. Tip It's good practice to add information about your model such as current selections and modifications for the reward function and algorithm as well as your hypothesis about how the model will perform. 3. Select the checkbox to automatically have your model submitted to the AWS DeepRacer Student leaderboard after training is complete. Optionally, you may opt out of entering your model by deselecting the checkbox. Step 6: Choose duration and submit your model to the leaderboard 18 AWS DeepRacer Student Tip User Guide We recommend that you submit your model to the leaderboard. Submitting your model helps you to see how your model compares to others and provides you with feedback so you can improve your model. 4. Choose Train your model. 5. In the Initializing model training pop-up, choose Okay. 6. On the Training configuration page, you can review your model's training status and configuration. You can also view a video of your model training on the selected track when the training Status is In progress. Watching the video can help you develop valuable insights that you can use to improve your model. Step 7: View your model's performance on the leaderboard After you have trained your model and submitted it to a leaderboard, you can
|
student-userguide-009
|
student-userguide.pdf
| 9 |
provides you with feedback so you can improve your model. 4. Choose Train your model. 5. In the Initializing model training pop-up, choose Okay. 6. On the Training configuration page, you can review your model's training status and configuration. You can also view a video of your model training on the selected track when the training Status is In progress. Watching the video can help you develop valuable insights that you can use to improve your model. Step 7: View your model's performance on the leaderboard After you have trained your model and submitted it to a leaderboard, you can view its performance. To view your model's performance 1. In the left navigation pane, navigate to and expand Compete. Choose a season. On the Leaderboard page, your model and your rank appear in a section. The page also includes a Leaderboard section with a list of the submitted models, race details, and a Race details section. 2. In the page that displays the leaderboard, in the section with your profile, select Watch Video to view a video of your model's performance. Step 8: Use Clone to improve your model After you have trained and optionally submitted your model to a leaderboard, you can clone it to improve it. Cloning your model saves you steps and makes training more efficient by using a previously trained model as the starting point for a new model. To clone and impove a model 1. In AWS DeepRacer Student, in the left navigation pane, navigate to Your models. Step 7: View your model's performance on the leaderboard 19 AWS DeepRacer Student User Guide 2. On the Your models page, select a model and choose Clone. 3. In the Name your model field, provide a new name for your cloned model and choose Next. 4. On the Customize a reward function page, customize the reward function and choose Next. For more information about customizing the reward function, see Step 5: Customize your reward function. 5. In the Choose duration page, enter a time in the Choose duration of model training field, enter a description in the Model description field, and select the checkbox to submit the cloned model to the leaderboard. 6. Choose Train your model. Your training is initialized. The Training configuration page appears with information about your cloned model. You can also view a video of your model training on the selected track when the training Status is In progress. 7. Continue cloning and modifying your pre-trained models to achieve your best performance on the leaderboard. Step 9: (Optional) Download a model After training a model and optionally submitting it to the leaderboard, you may want to download it for future use on a AWS DeepRacer physical device. Your model is saved as a .tar.gz file. To download a model 1. In AWS DeepRacer Student, in the left navigation pane, navigate to Your models. 2. On the Your models page, select a model and choose Download. 3. Track the progress of the model download in your browser. When your model is downloaded, you can save it to your local hard drive or other preferred storage device. To learn more about working with AWS DeepRacer devices, see Operate Your AWS DeepRacer Vehicle in the AWS DeepRacer guide. Step 9: (Optional) Download a model 20 AWS DeepRacer Student User Guide Join an AWS DeepRacer Student race After successfully training and evaluating your model in simulation, compare your model's performance to other racers' models by participating in a race. Racing is a great way to get feedback about your model, win awards and prizes, meet other AWS DeepRacer Student community members virtually, hear about opportunities to learn and improve your skills, and have fun. There are two types of student races: student league and community. A student league race is a monthly virtual competition that all students can join. A student community race is a private race created by an educator or event organizer in the AWS console that students can join by invitation only. This section discusses how to participate in an AWS DeepRacer Student student league race and student community race. Join a student league race In this section, learn how to submit your model to an AWS DeepRacer Student student league race. You can join a race every month by submitting a trained model directly to a student leaderboard. For more information about training models, see Training a reinforcement learning model in AWS DeepRacer Student. To join a student league race 1. 2. 3. In the left navigation pane in AWS DeepRacer Student, expand Compete and choose Student league. The page displays race details and the leaderboard. In the Open races section, choose Enter race to submit a model, or if you haven't already created a model, choose Create model. For more information, see
|
student-userguide-010
|
student-userguide.pdf
| 10 |
to an AWS DeepRacer Student student league race. You can join a race every month by submitting a trained model directly to a student leaderboard. For more information about training models, see Training a reinforcement learning model in AWS DeepRacer Student. To join a student league race 1. 2. 3. In the left navigation pane in AWS DeepRacer Student, expand Compete and choose Student league. The page displays race details and the leaderboard. In the Open races section, choose Enter race to submit a model, or if you haven't already created a model, choose Create model. For more information, see Training a reinforcement learning model in AWS DeepRacer Student. In the Choose a model to race section, use the dropdown list to choose a model in the Choose a model field. 4. Choose Join race to submit your model. 5. Once your model has been evaluated sucessfully against the racing criteria, check the leaderboard to see how your model ranks against other participants. 6. Optionally, choose Watch to view a video of your car's performance. Join a student league race 21 AWS DeepRacer Student User Guide 7. Choose Race again to enter another model. The submission quota for each AWS DeepRacer Student League race is 50. Join a student community race In this section, learn how to submit your model to an AWS DeepRacer Student student community race. You can join the student community race by receiving an invitation link from your educator or event organizer through email. To join a student community race 1. Go to the invitation link and log in to your AWS DeepRacer student account. 2. Once you are signed in, choose the Enter race button. 3. In the Choose a model to race dropdown list, select your model to use in the community race. 4. Choose Enter race to submit your model. 5. If your model is evaluated sucessfully against the racing criteria, check the leaderboard to see how your model ranks against the models of other participants. 6. Optionally, choose Watch to view a video of your car's performance. 7. Choose Race again to enter another model. Join a student community race 22 AWS DeepRacer Student User Guide Customizing a reward function Creating a reward function is like designing an incentive plan. Parameters are values that can be used to develop your incentive plan. Different incentive strategies result in different vehicle behaviors. To encourage the vehicle to drive faster, try awarding negative values when the car takes too long to finish a lap or goes off the track. To avoid zig-zag driving patterns, try defining a steering angle range limit and rewarding the car for steering less aggressively on straight sections of the track. You can use waypoints, which are numbered markers placed along the centerline and outer and inner edges of the track, to help you associate certain driving behaviors with specific features of a track, like straightaways and curves. Crafting an effective reward function is a creative and iterative process. Try different strategies, mix and match parameters, and most importantly, have fun! Topics • Editing Python code to customize your reward function • Input parameters of the AWS DeepRacer reward function Editing Python code to customize your reward function In AWS DeepRacer Student, you can edit sample reward functions to craft a custom racing strategy for your model. To customize your reward function 1. On the Step 5: Customize reward function page of the AWS DeepRacer Student Create model experience, select a sample reward function. 2. Use the code editor below the sample reward function picker to customize the reward function's input parameters using Python code. 3. Select Validate to check whether or not your code will work. Alternatively, choose Reset to start over. 4. Once you're done making changes, select Next. Editing Python code to customize your reward function 23 AWS DeepRacer Student User Guide Use Input parameters of the AWS DeepRacer reward function to learn about each parameter. See how different parameters are used in reward function examples. Input parameters of the AWS DeepRacer reward function The AWS DeepRacer reward function takes a dictionary object passed as the variable, params, as the input. def reward_function(params) : reward = ... return float(reward) The params dictionary object contains the following key-value pairs: { "all_wheels_on_track": Boolean, # flag to indicate if the agent is on the track "x": float, # agent's x-coordinate in meters "y": float, # agent's y-coordinate in meters "closest_objects": [int, int], # zero-based indices of the two closest objects to the agent's current position of (x, y). "closest_waypoints": [int, int], # indices of the two nearest waypoints. "distance_from_center": float, # distance in meters from the track center "is_crashed": Boolean, # Boolean flag to indicate whether the agent has crashed. "is_left_of_center": Boolean, # Flag to indicate if the agent is on
|
student-userguide-011
|
student-userguide.pdf
| 11 |
float(reward) The params dictionary object contains the following key-value pairs: { "all_wheels_on_track": Boolean, # flag to indicate if the agent is on the track "x": float, # agent's x-coordinate in meters "y": float, # agent's y-coordinate in meters "closest_objects": [int, int], # zero-based indices of the two closest objects to the agent's current position of (x, y). "closest_waypoints": [int, int], # indices of the two nearest waypoints. "distance_from_center": float, # distance in meters from the track center "is_crashed": Boolean, # Boolean flag to indicate whether the agent has crashed. "is_left_of_center": Boolean, # Flag to indicate if the agent is on the left side to the track center or not. "is_offtrack": Boolean, # Boolean flag to indicate whether the agent has gone off track. "is_reversed": Boolean, # flag to indicate if the agent is driving clockwise (True) or counter clockwise (False). "heading": float, # agent's yaw in degrees "objects_distance": [float, ], # list of the objects' distances in meters between 0 and track_length in relation to the starting line. "objects_heading": [float, ], # list of the objects' headings in degrees between -180 and 180. "objects_left_of_center": [Boolean, ], # list of Boolean flags indicating whether elements' objects are left of the center (True) or not (False). "objects_location": [(float, float),], # list of object locations [(x,y), ...]. Reward function input parameters 24 AWS DeepRacer Student User Guide "objects_speed": [float, ], # list of the objects' speeds in meters per second. "progress": float, # percentage of track completed "speed": float, # agent's speed in meters per second (m/s) "steering_angle": float, # agent's steering angle in degrees "steps": int, # number steps completed "track_length": float, # track length in meters. "track_width": float, # width of the track "waypoints": [(float, float), ] # list of (x,y) as milestones along the track center } Use the following reference to get a better understanding of the AWS DeepRacer input parameters. all_wheels_on_track Type: Boolean Range: (True:False) A Boolean flag to indicate whether the agent is on track or not on track. The agent is not on track (False) if any of its wheels are outside of the track borders. It's on track (True) if all four wheels are inside the inner and outer track borders. The following illustration shows an agent that is on track. all_wheels_on_track 25 AWS DeepRacer Student User Guide The following illustration shows an agent that is not on track because two wheels are outside of track borders. Example: A reward function using the all_wheels_on_track parameter def reward_function(params): ############################################################################# ''' Example of using all_wheels_on_track and speed ''' # Read input variables all_wheels_on_track = params['all_wheels_on_track'] speed = params['speed'] # Set the speed threshold based your action space SPEED_THRESHOLD = 1.0 if not all_wheels_on_track: # Penalize if the car goes off track reward = 1e-3 elif speed < SPEED_THRESHOLD: # Penalize if the car goes too slow reward = 0.5 else: # High reward if the car stays on track and goes fast reward = 1.0 return float(reward) all_wheels_on_track 26 AWS DeepRacer Student User Guide closest_waypoints Type: [int, int] Range: [(0:Max-1),(1:Max-1)] The zero-based indices of the two neighboring waypoints closest to the agent's current position of (x, y). The distance is measured by the Euclidean distance from the center of the agent. The first element refers to the closest waypoint behind the agent and the second element refers the closest waypoint in front of the agent. Max is the length of the waypoints list. In the illustration shown in waypoints, the closest_waypoints are [16, 17]. The following example reward function demonstrates how to use waypoints and closest_waypoints as well as heading to calculate immediate rewards. AWS DeepRacer supports the following Python libraries: math, random, numpy, scipy, and shapely. To use one, add an import statement, import supported library, preceding your function definition, def reward_function(params). Example: A reward function using the closest_waypoints parameter. # Place import statement outside of function (supported libraries: math, random, numpy, scipy, and shapely) # Example imports of available libraries # # import math # import random # import numpy # import scipy # import shapely import math def reward_function(params): ############################################################################### ''' Example of using waypoints and heading to make the car point in the right direction ''' closest_waypoints 27 AWS DeepRacer Student # Read input variables waypoints = params['waypoints'] closest_waypoints = params['closest_waypoints'] heading = params['heading'] # Initialize the reward with typical value reward = 1.0 User Guide # Calculate the direction of the centerline based on the closest waypoints next_point = waypoints[closest_waypoints[1]] prev_point = waypoints[closest_waypoints[0]] # Calculate the direction in radius, arctan2(dy, dx), the result is (-pi, pi) in radians track_direction = math.atan2(next_point[1] - prev_point[1], next_point[0] - prev_point[0]) # Convert to degree track_direction = math.degrees(track_direction) # Calculate the difference between the track direction and the heading direction of the car direction_diff = abs(track_direction - heading) if direction_diff > 180: direction_diff = 360 - direction_diff
|
student-userguide-012
|
student-userguide.pdf
| 12 |
input variables waypoints = params['waypoints'] closest_waypoints = params['closest_waypoints'] heading = params['heading'] # Initialize the reward with typical value reward = 1.0 User Guide # Calculate the direction of the centerline based on the closest waypoints next_point = waypoints[closest_waypoints[1]] prev_point = waypoints[closest_waypoints[0]] # Calculate the direction in radius, arctan2(dy, dx), the result is (-pi, pi) in radians track_direction = math.atan2(next_point[1] - prev_point[1], next_point[0] - prev_point[0]) # Convert to degree track_direction = math.degrees(track_direction) # Calculate the difference between the track direction and the heading direction of the car direction_diff = abs(track_direction - heading) if direction_diff > 180: direction_diff = 360 - direction_diff # Penalize the reward if the difference is too large DIRECTION_THRESHOLD = 10.0 if direction_diff > DIRECTION_THRESHOLD: reward *= 0.5 return float(reward) closest_objects Type: [int, int] Range: [(0:len(object_locations)-1), (0:len(object_locations)-1] The zero-based indices of the two closest objects to the agent's current position of (x, y). The first index refers to the closest object behind the agent, and the second index refers to the closest object in front of the agent. If there is only one object, both indices are 0. closest_objects 28 AWS DeepRacer Student distance_from_center Type: float Range: 0:~track_width/2 User Guide Displacement, in meters, between the agent's center and the track's center. The observable maximum displacement occurs when any of the agent's wheels are outside a track border and, depending on the width of the track border, can be slightly smaller or larger than half the track_width. Example: A reward function using the distance_from_center parameter def reward_function(params): ################################################################################# ''' Example of using distance from the center ''' # Read input variable track_width = params['track_width'] distance_from_center = params['distance_from_center'] distance_from_center 29 AWS DeepRacer Student User Guide # Penalize if the car is too far away from the center marker_1 = 0.1 * track_width marker_2 = 0.5 * track_width if distance_from_center <= marker_1: reward = 1.0 elif distance_from_center <= marker_2: reward = 0.5 else: reward = 1e-3 # likely crashed/ close to off track return float(reward) heading Type: float Range: -180:+180 The heading direction, in degrees, of the agent with respect to the x-axis of the coordinate system. Example: A reward function using the heading parameter For more information, see closest_waypoints. heading 30 AWS DeepRacer Student is_crashed Type: Boolean Range: (True:False) User Guide A Boolean flag that indicates whether the agent has crashed into another object (True) or not (False) as a termination status. is_left_of_center Type: Boolean Range: [True : False] A Boolean flag that indicates if the agent is left of the track center (True) or not left of the track center (False). is_offtrack Type: Boolean Range: (True:False) A Boolean flag that indicate if all four of the agent's wheels have driven outside of the track's inner or outer boarders (True) or not (False). is_reversed Type: Boolean Range: [True:False] A Boolean flag that indicates if the agent is driving clockwise (True) or counterclockwise (False). It's used when you enable direction change for each episode. objects_distance Type: [float, … ] is_crashed 31 AWS DeepRacer Student User Guide Range: [(0:track_length), … ] A list of distances between objects in the environment in relation to the starting line. The ith element measures the distance in meters between the ith object and the starting line along the track center line. Note abs | (var1) - (var2)| = how close the car is to an object, WHEN var1 = ["objects_distance"] [index] and var2 = params["progress"]*params["track_length"] To get an index of the closest object in front of the vehicle and the closest object behind the vehicle, use the closest_objects parameter. objects_heading Type: [float, … ] Range: [(-180:180), … ] List of the headings of objects in degrees. The ith element measures the heading of the ith object. Stationary objects' headings are 0. For bot cars, the corresponding element's value is the bot car's heading angle. objects_left_of_center Type: [Boolean, … ] Range: [True|False, … ] List of Boolean flags. The ith element value indicates whether the ith object is to the left (True) or right (False) of the track center. objects_location Type: [(x,y), ...] Range: [(0:N,0:N), ...] This parameter stores all object locations. Each location is a tuple of (x, y). objects_heading 32 AWS DeepRacer Student User Guide The size of the list equals the number of objects on the track. The objects listed include both stationary obstacles and moving bot cars. objects_speed Type: [float, … ] Range: [(0:12.0), … ] List of speeds (meters per second) for the objects on the track. For stationary objects, their speeds are 0. For a bot vehicle, the value is the speed you set in training. progress Type: float Range: 0:100 Percentage of track completed. Example: A reward function using the progress parameter For more information, see steps. speed Type: float Range: 0.0:5.0 The observed speed of the agent, in meters per second (m/s). objects_speed 33 AWS DeepRacer Student User Guide
|
student-userguide-013
|
student-userguide.pdf
| 13 |
on the track. The objects listed include both stationary obstacles and moving bot cars. objects_speed Type: [float, … ] Range: [(0:12.0), … ] List of speeds (meters per second) for the objects on the track. For stationary objects, their speeds are 0. For a bot vehicle, the value is the speed you set in training. progress Type: float Range: 0:100 Percentage of track completed. Example: A reward function using the progress parameter For more information, see steps. speed Type: float Range: 0.0:5.0 The observed speed of the agent, in meters per second (m/s). objects_speed 33 AWS DeepRacer Student User Guide Example: A reward function using the speed parameter For more information, see all_wheels_on_track. steering_angle Type: float Range: -30:30 Steering angle, in degrees, of the front wheels from the center line of the agent. The negative sign (-) means steering to the right and the positive (+) sign means steering to the left. The agent's centerline is not necessarily parallel with the track center line as is shown in the following illustration. steering_angle 34 AWS DeepRacer Student User Guide Example: A reward function using the steering_angle parameter def reward_function(params): ''' Example of using steering angle ''' # Read input variable abs_steering = abs(params['steering_angle']) # We don't care whether it is left or right steering # Initialize the reward with typical value reward = 1.0 # Penalize if car steer too much to prevent zigzag ABS_STEERING_THRESHOLD = 20.0 if abs_steering > ABS_STEERING_THRESHOLD: reward *= 0.8 return float(reward) steering_angle 35 AWS DeepRacer Student steps Type: int Range: 0:Nstep User Guide The number of steps completed. A step corresponds to one observation-action sequence completed by the agent using the current policy. Example: A reward function using the steps parameter def reward_function(params): ############################################################################# ''' Example of using steps and progress ''' # Read input variable steps = params['steps'] progress = params['progress'] # Total num of steps we want the car to finish the lap, it will vary depends on the track length TOTAL_NUM_STEPS = 300 # Initialize the reward with typical value reward = 1.0 # Give additional reward if the car pass every 100 steps faster than expected if (steps % 100) == 0 and progress > (steps / TOTAL_NUM_STEPS) * 100 : reward += 10.0 return float(reward) track_length Type: float Range: [0:Lmax] The track length in meters. Lmax is track-dependent. steps 36 AWS DeepRacer Student track_width Type: float Range: 0:Dtrack Track width in meters. User Guide Example: A reward function using the track_width parameter def reward_function(params): ############################################################################# ''' Example of using track width ''' # Read input variable track_width = params['track_width'] distance_from_center = params['distance_from_center'] # Calculate the distance from each border distance_from_border = 0.5 * track_width - distance_from_center track_width 37 AWS DeepRacer Student User Guide # Reward higher if the car stays inside the track borders if distance_from_border >= 0.05: reward = 1.0 else: reward = 1e-3 # Low reward if too close to the border or goes off the track return float(reward) x, y Type: float Range: 0:N Location, in meters, of the agent's center along the x and y axes of the simulated environment containing the track. The origin is at the lower-left corner of the simulated environment. x, y 38 AWS DeepRacer Student waypoints Type: list of [float, float] Range: [[xw,0,yw,0] … [xw,Max-1, yw,Max-1]] User Guide An ordered list of track-dependent Max milestones along the track center. Each milestone is described by a coordinate of (xw,i, yw,i). For a looped track, the first and last waypoints are the same. For a straight or other non-looped track, the first and last waypoints are different. Example A reward function using the waypoints parameter For more information, see closest_waypoints. waypoints 39 AWS DeepRacer Student User Guide Security in AWS DeepRacer Student Cloud security at AWS is the highest priority. As an AWS customer, you benefit from a data center and network architecture that is built to meet the requirements of the most security-sensitive organizations. Security is a shared responsibility between AWS and you. The shared responsibility model describes this as security of the cloud and security in the cloud: • Security of the cloud – AWS is responsible for protecting the infrastructure that runs AWS services in the AWS Cloud. AWS also provides you with services that you can use securely. Third- party auditors regularly test and verify the effectiveness of our security as part of the AWS Compliance Programs. To learn about the compliance programs that apply to AWS DeepRacer Student, see AWS Services in Scope by Compliance Program. • Security in the cloud – Your responsibility is determined by the AWS service that you use. You are also responsible for other factors including the sensitivity of your data, your company’s requirements, and applicable laws and regulations This documentation helps you understand how to apply the shared responsibility model when using AWS
|
student-userguide-014
|
student-userguide.pdf
| 14 |
you with services that you can use securely. Third- party auditors regularly test and verify the effectiveness of our security as part of the AWS Compliance Programs. To learn about the compliance programs that apply to AWS DeepRacer Student, see AWS Services in Scope by Compliance Program. • Security in the cloud – Your responsibility is determined by the AWS service that you use. You are also responsible for other factors including the sensitivity of your data, your company’s requirements, and applicable laws and regulations This documentation helps you understand how to apply the shared responsibility model when using AWS DeepRacer Student. It shows you how to configure AWS DeepRacer Student to meet your security and compliance objectives. You also learn how to use other AWS services that help you to monitor and secure your AWS DeepRacer Student resources. Contents • Data protection in AWS DeepRacer Student • Identity and access management for AWS DeepRacer Student • Compliance validation for AWS DeepRacer Student • Resilience in AWS DeepRacer Student • Infrastructure security in AWS DeepRacer Student Data protection in AWS DeepRacer Student The following sections explain what data is captured by AWS DeepRacer Student, and where AWS DeepRacer Student uses data encryption to protect your data. Data protection 40 AWS DeepRacer Student User Guide When you create a AWS DeepRacer Student account you also create an AWS Player account. Resources created in your AWS DeepRacer Student account are stored in your AWS Player account. For more details about AWS Player accounts, see What are AWS Player accounts? in the AWS DeepRacer Student User Guide. Topics • Captured data in the AWS DeepRacer Student portal • Encryption at rest in AWS DeepRacer Student portal • Encryption in transit in AWS DeepRacer Student portal Captured data in the AWS DeepRacer Student portal To use the AWS DeepRacer Student portal, the required data is stored in your AWS Player account. The data captured in the AWS DeepRacer Student portal is not used to help improve the service. Captured data in AWS DeepRacer Student. The following is a summary of data created in AWS DeepRacer Student and stored in your AWS Player account. • Your email address and password used to register your account. • Your racer name • Your standing on the Student League leaderboard • Your trained models • Reward function code Encryption at rest in AWS DeepRacer Student portal Data captured by AWS DeepRacer Student portal is encrypted by default. AWS Player accounts use Amazon Cognito to encrypt and store the email and password used to login to AWS DeepRacer Student. For more information, see Data Protection in Amazon Cognito. All other data captured in AWS DeepRacer Student is encrypted at rest in the cloud using AWS owned keys through AWS Key Management Service with AES-GCM and using keys of size 256-bits. This data is stored and encrypted in Amazon Simple Storage Service (S3) and Amazon DynamoDB. Captured data in the AWS DeepRacer Student portal 41 AWS DeepRacer Student User Guide Encryption in transit in AWS DeepRacer Student portal Your registered and authorized email addresses are encrypted with client-side encryption. All other data captured in AWS DeepRacer Student is copied out of your account and processed in an internal AWS system. By default, AWS DeepRacer Student uses secure connections over HTTPS to encrypt data in transit. Identity and access management for AWS DeepRacer Student AWS Identity and Access Management (IAM) is an AWS service that helps an administrator securely control access to AWS resources. IAM administrators control who can be authenticated (signed in) and authorized (have permissions) to use AWS resources. AWS DeepRacer Student does not directly integrate with IAM to control user access to AWS resources. Instead, AWS DeepRacer Student uses an authenticated proxy API managed by AWS DeepRacer to secure user resources. Compliance validation for AWS DeepRacer Student Third-party auditors assess the security and compliance of AWS DeepRacer Student as part of multiple AWS compliance programs. For a list of AWS services in scope of specific compliance programs, see AWS Services in Scope by Compliance Program. For general information, see AWS Compliance Programs. You can download third-party audit reports using AWS Artifact. For more information, see Downloading Reports in AWS Artifact. AWS provides the following resources to help with compliance: • Security and Compliance Quick Start Guides – These deployment guides discuss architectural considerations and provide steps for deploying security- and compliance-focused baseline environments on AWS. • AWS Compliance Resources – This collection of workbooks and guides might apply to your industry and location. • Evaluating Resources with Rules in the AWS Config Developer Guide – AWS Config; assesses how well your resource configurations comply with internal practices, industry guidelines, and regulations. • AWS Security Hub – This AWS service provides a comprehensive view of your security state within
|
student-userguide-015
|
student-userguide.pdf
| 15 |
AWS Artifact. AWS provides the following resources to help with compliance: • Security and Compliance Quick Start Guides – These deployment guides discuss architectural considerations and provide steps for deploying security- and compliance-focused baseline environments on AWS. • AWS Compliance Resources – This collection of workbooks and guides might apply to your industry and location. • Evaluating Resources with Rules in the AWS Config Developer Guide – AWS Config; assesses how well your resource configurations comply with internal practices, industry guidelines, and regulations. • AWS Security Hub – This AWS service provides a comprehensive view of your security state within AWS that helps you check your compliance with security industry standards and best practices. Encryption in transit in AWS DeepRacer Student portal 42 AWS DeepRacer Student User Guide Resilience in AWS DeepRacer Student The AWS global infrastructure is built around AWS Regions and Availability Zones. Regions provide multiple physically separated and isolated Availability Zones, which are connected through low-latency, high-throughput, and highly redundant networking. With Availability Zones, you can design and operate applications and databases that automatically fail over between zones without interruption. Availability Zones are more highly available, fault tolerant, and scalable than traditional single or multiple data center infrastructures. For more information about AWS Regions and Availability Zones, see AWS Global Infrastructure. Infrastructure security in AWS DeepRacer Student As a managed service, AWS DeepRacer Student is protected by the AWS global network security procedures that are described in the Amazon Web Services: Overview of Security Processes whitepaper. Resilience 43 AWS DeepRacer Student User Guide Troubleshooting common AWS DeepRacer Student issues Topics • Why was I automatically signed out of my AWS DeepRacer Student account? • How do I opt out of the AWS AI & ML Scholarship program? • I can't delete my AWS DeepRacer Student account • I can't find my school name on the dropdown list • I can't continue training my model • I get an "An account is registered with this email" error message • I signed up with a Gmail account and can't find my verification code Why was I automatically signed out of my AWS DeepRacer Student account? In compliance with AWS security policy, you are automatically signed out of your AWS DeepRacer Student account after 30 days. • To continue using the service, navigate to the AWS DeepRacer Student sign-in page and use your credentials to sign back in. How do I opt out of the AWS AI & ML Scholarship program? The AWS AI & ML Scholarship program is optional and intended for underserved and underrepresented students who are 16 years or older. When you sign up for AWS DeepRacer Student, by default you are not enrolled in the AWS AI & ML Scholarship program. To participate, you must first opt in by checking the box in the Do you want to be considered for the AWS AI & ML Scholarship program? section as you sign up for AWS DeepRacer Student or later from the Your profile page, which is accessible from the site's left navigation pane. • Opting in to the program only gives you access to the application process. You can still choose not to apply. Why was I automatically signed out of my AWS DeepRacer Student account? 44 AWS DeepRacer Student User Guide I can't delete my AWS DeepRacer Student account If you can't delete your AWS DeepRacer Student account, check to see if you've created an AWS DeepRacer multi-user event. AWS Player accounts are a managed identity solution created by AWS for AWS DeepRacer multi-user and AWS DeepRacer Student. Your AWS Player account holds all of the resources created in each of these AWS services. • To ensure that participants of events you create are not left with a broken experience, you can't delete your AWS DeepRacer Student account if it contains resources for an AWS DeepRacer multi-user event. I can't find my school name on the dropdown list You may not find all schools on the dropdown list, particularly high schools. • If your school isn't on the dropdown list, choose Other and enter your school name. I can't continue training my model You may have exceeded the monthly model training-hour limit. • Go to the Home page to check your Used training hours in the Model training hours remaining section. If you have exceeded your model training hours, wait until your hours reset to begin training again. I get an "An account is registered with this email" error message You receive this error message when you enter a confirmation code into the AWS Player account Sign up page and you've already used the same email address to sign up for an AWS Player account through AWS DeepRacer multi-user. You also receive this error when you've previously used the same email address to sign up
|
student-userguide-016
|
student-userguide.pdf
| 16 |
the Home page to check your Used training hours in the Model training hours remaining section. If you have exceeded your model training hours, wait until your hours reset to begin training again. I get an "An account is registered with this email" error message You receive this error message when you enter a confirmation code into the AWS Player account Sign up page and you've already used the same email address to sign up for an AWS Player account through AWS DeepRacer multi-user. You also receive this error when you've previously used the same email address to sign up for an AWS DeepRacer Student account. • Sign in to the AWS DeepRacer Student sign-in page using the credentials you've previously created or request a password reset by selecting Forgot password? under the Password field. I can't delete my AWS DeepRacer Student account 45 AWS DeepRacer Student User Guide I signed up with a Gmail account and can't find my verification code If you've signed up for an AWS Player account using a Gmail account and can't find your verification code message, it may have been delivered to the wrong folder. • Sign in to your Gmail account and check your Promotions folder for a message titled, "Your AWS Player profile verification code". I signed up with a Gmail account and can't find my verification code 46 AWS DeepRacer Student User Guide Quotas for AWS DeepRacer Student Every student participating in AWS DeepRacer Student receives 10 free hours of monthly model training compute resources and 5GB of storage. 47 AWS DeepRacer Student User Guide Deleting your AWS DeepRacer Student account The AWS DeepRacer Student portal stores the following information in your AWS Player account: • Email address • Your password • Your racer name • Your Student League leaderboard rank To learn more about the data collected, see Data protection in AWS DeepRacer Student in the AWS DeepRacer Student User Guide. If you want to remove this information from AWS's servers, use the following procedure to delete your AWS DeepRacer Student portal account. Deleting your AWS DeepRacer Student account also deletes your AWS Player account and all associated resources. To learn more about AWS Player accounts, see What are AWS Player accounts? Note If you have created AWS DeepRacer multi-user event, you cannot delete your AWS Player account. For more details, see I can't delete my AWS DeepRacer Student account in the AWS DeepRacer Student User Guide. To delete your AWS DeepRacer Student player account Important Deleting your AWS DeepRacer Student account is an action that cannot be undone. When you delete your AWS DeepRacer Student you are also deleting your AWS Player account and all associated resources. When you delete your AWS DeepRacer Student account, the resources in your AWS Player account are removed from our servers within one year. 1. Open the AWS DeepRacer Student landing page: https://student.deepracer.com/signIn. 48 AWS DeepRacer Student User Guide 2. If prompted, log in to your AWS DeepRacer Student account. 3. Choose Your account. 4. On the Your account page, choose Delete your account. 5. Under To confirm deletion, type Delete in the field, type Delete. 6. Choose Delete. When your account is deleted successfully, the message Account deleted successfully appears and you are returned to the AWS DeepRacer Student login page. If you would also like to delete your AWS account, use the steps outlined in Closing your AWS account. We know customers care deeply about privacy and data security and we implement responsible and sophisticated technical and physical controls designed to prevent unauthorized access to or disclosure of customer content. Maintaining customer trust is an ongoing commitment. You can learn more about AWS data privacy commitments on our Privacy Notice page. 49 AWS DeepRacer Student User Guide Document history for the AWS DeepRacer Student User Guide The following table describes the documentation releases for AWS DeepRacer Student. Change Description Date Updates for the 2024 program November 1, 2023 Updates to topics referenci ng the 2024 AWS AI & ML Scholarship program and AWS DeepRacer Student League. Added information about the new course available to all students who apply for AWS AI & ML Scholarship. Updates for the 2023 AWS DeepRacer Student League Updates to multiple topics referencing the 2023 AWS March 1, 2023 Initial release DeepRacer Student League. For more information, see the terms and conditions. Initial release of the AWS DeepRacer Student User Guide including support for the AWS AI & ML Scholarship program and AWS DeepRacer Student League. December 1, 2021 50
|
supply-chain-api-001
|
supply-chain-api.pdf
| 1 |
API Reference AWS Supply Chain API Version 2024-01-01 Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. AWS Supply Chain API Reference AWS Supply Chain: 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 Supply Chain Table of Contents API Reference Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 2 CreateBillOfMaterialsImportJob ................................................................................................................ 4 Request Syntax ........................................................................................................................................ 4 URI Request Parameters ........................................................................................................................ 4 Request Body ........................................................................................................................................... 4 Response Syntax ...................................................................................................................................... 5 Response Elements ................................................................................................................................. 5 Errors .......................................................................................................................................................... 6 See Also ..................................................................................................................................................... 7 CreateDataIntegrationFlow ......................................................................................................................... 8 Request Syntax ........................................................................................................................................ 8 URI Request Parameters ........................................................................................................................ 9 Request Body ......................................................................................................................................... 10 Response Syntax ................................................................................................................................... 11 Response Elements ............................................................................................................................... 11 Errors ....................................................................................................................................................... 12 See Also .................................................................................................................................................. 13 CreateDataLakeDataset ............................................................................................................................. 14 Request Syntax ...................................................................................................................................... 14 URI Request Parameters ...................................................................................................................... 15 Request Body ......................................................................................................................................... 15 Response Syntax ................................................................................................................................... 17 Response Elements ............................................................................................................................... 18 Errors ....................................................................................................................................................... 18 See Also .................................................................................................................................................. 19 CreateDataLakeNamespace ...................................................................................................................... 20 Request Syntax ...................................................................................................................................... 20 URI Request Parameters ...................................................................................................................... 20 Request Body ......................................................................................................................................... 21 Response Syntax ................................................................................................................................... 21 Response Elements ............................................................................................................................... 22 Errors ....................................................................................................................................................... 22 See Also .................................................................................................................................................. 23 API Version 2024-01-01 iii AWS Supply Chain API Reference CreateInstance ............................................................................................................................................. 24 Request Syntax ...................................................................................................................................... 24 URI Request Parameters ...................................................................................................................... 24 Request Body ......................................................................................................................................... 24 Response Syntax ................................................................................................................................... 26 Response Elements ............................................................................................................................... 27 Errors ....................................................................................................................................................... 27 See Also .................................................................................................................................................. 28 DeleteDataIntegrationFlow ...................................................................................................................... 29 Request Syntax ...................................................................................................................................... 29 URI Request Parameters ...................................................................................................................... 29 Request Body ......................................................................................................................................... 29 Response Syntax ................................................................................................................................... 29 Response Elements ............................................................................................................................... 30 Errors ....................................................................................................................................................... 30 See Also .................................................................................................................................................. 31 DeleteDataLakeDataset ............................................................................................................................. 33 Request Syntax ...................................................................................................................................... 33 URI Request Parameters ...................................................................................................................... 33 Request Body ......................................................................................................................................... 34 Response Syntax ................................................................................................................................... 34 Response Elements ............................................................................................................................... 34 Errors ....................................................................................................................................................... 35 See Also .................................................................................................................................................. 36 DeleteDataLakeNamespace ...................................................................................................................... 37 Request Syntax ...................................................................................................................................... 37 URI Request Parameters ...................................................................................................................... 37 Request Body ......................................................................................................................................... 37 Response Syntax ................................................................................................................................... 37 Response Elements ............................................................................................................................... 38 Errors ....................................................................................................................................................... 38 See Also .................................................................................................................................................. 39 DeleteInstance ............................................................................................................................................. 41 Request Syntax ...................................................................................................................................... 41 URI Request Parameters ...................................................................................................................... 41 Request Body ......................................................................................................................................... 41 API Version 2024-01-01 iv AWS Supply Chain API Reference Response Syntax ................................................................................................................................... 41 Response Elements ............................................................................................................................... 42 Errors ....................................................................................................................................................... 42 See Also .................................................................................................................................................. 43 GetBillOfMaterialsImportJob ................................................................................................................... 45 Request Syntax ...................................................................................................................................... 45 URI Request Parameters ...................................................................................................................... 45 Request Body ......................................................................................................................................... 45 Response Syntax ................................................................................................................................... 45 Response Elements ............................................................................................................................... 46 Errors ....................................................................................................................................................... 46 See Also .................................................................................................................................................. 47 GetDataIntegrationEvent .......................................................................................................................... 49 Request Syntax ...................................................................................................................................... 49 URI Request Parameters ...................................................................................................................... 49 Request Body ......................................................................................................................................... 49 Response Syntax ................................................................................................................................... 49 Response Elements ............................................................................................................................... 50 Errors ....................................................................................................................................................... 50 See Also .................................................................................................................................................. 51 GetDataIntegrationFlow ............................................................................................................................ 53 Request Syntax ...................................................................................................................................... 53 URI Request Parameters ...................................................................................................................... 53 Request Body ......................................................................................................................................... 53 Response Syntax ................................................................................................................................... 53 Response Elements ............................................................................................................................... 55 Errors ....................................................................................................................................................... 56 See Also .................................................................................................................................................. 57 GetDataIntegrationFlowExecution .......................................................................................................... 58 Request Syntax ...................................................................................................................................... 58 URI Request Parameters ...................................................................................................................... 58 Request Body ......................................................................................................................................... 59 Response Syntax ................................................................................................................................... 59 Response Elements ............................................................................................................................... 59 Errors ....................................................................................................................................................... 60 See Also .................................................................................................................................................. 61 API Version 2024-01-01 v AWS Supply Chain API Reference GetDataLakeDataset .................................................................................................................................. 62 Request Syntax ...................................................................................................................................... 62 URI Request Parameters ...................................................................................................................... 62 Request Body ......................................................................................................................................... 63 Response Syntax ................................................................................................................................... 63 Response Elements ............................................................................................................................... 64 Errors ....................................................................................................................................................... 64 See Also .................................................................................................................................................. 65 GetDataLakeNamespace ........................................................................................................................... 67 Request Syntax ...................................................................................................................................... 67 URI Request Parameters ...................................................................................................................... 67 Request Body ......................................................................................................................................... 67 Response Syntax ................................................................................................................................... 68 Response Elements ............................................................................................................................... 68 Errors ....................................................................................................................................................... 68 See Also .................................................................................................................................................. 69 GetInstance .................................................................................................................................................. 71 Request Syntax ...................................................................................................................................... 71 URI Request Parameters ...................................................................................................................... 71 Request Body ......................................................................................................................................... 71 Response Syntax ................................................................................................................................... 71 Response Elements ............................................................................................................................... 72 Errors ....................................................................................................................................................... 72 See Also .................................................................................................................................................. 73 ListDataIntegrationEvents ........................................................................................................................ 74 Request Syntax ...................................................................................................................................... 74 URI Request Parameters ...................................................................................................................... 74 Request Body ......................................................................................................................................... 75 Response Syntax ................................................................................................................................... 75 Response Elements ............................................................................................................................... 75 Errors ....................................................................................................................................................... 76 See Also .................................................................................................................................................. 77 ListDataIntegrationFlowExecutions ........................................................................................................ 78 Request Syntax ...................................................................................................................................... 78 URI Request Parameters ...................................................................................................................... 78 Request Body ......................................................................................................................................... 79 API Version 2024-01-01 vi AWS Supply Chain API Reference Response Syntax ................................................................................................................................... 79 Response Elements ............................................................................................................................... 79 Errors ....................................................................................................................................................... 80 See Also .................................................................................................................................................. 81 ListDataIntegrationFlows .......................................................................................................................... 82 Request Syntax ...................................................................................................................................... 82 URI Request Parameters ...................................................................................................................... 82 Request Body ......................................................................................................................................... 82 Response Syntax ................................................................................................................................... 82 Response Elements ............................................................................................................................... 84 Errors ....................................................................................................................................................... 85 See Also .................................................................................................................................................. 86 ListDataLakeDatasets ................................................................................................................................. 87 Request Syntax ...................................................................................................................................... 87 URI Request Parameters ...................................................................................................................... 87 Request Body ......................................................................................................................................... 88 Response Syntax ................................................................................................................................... 88 Response Elements ............................................................................................................................... 89 Errors ....................................................................................................................................................... 89 See Also .................................................................................................................................................. 90 ListDataLakeNamespaces .......................................................................................................................... 92 Request Syntax ...................................................................................................................................... 92 URI Request Parameters ...................................................................................................................... 92 Request Body ......................................................................................................................................... 92 Response Syntax
|
supply-chain-api-002
|
supply-chain-api.pdf
| 2 |
AWS Supply Chain API Reference Response Syntax ................................................................................................................................... 79 Response Elements ............................................................................................................................... 79 Errors ....................................................................................................................................................... 80 See Also .................................................................................................................................................. 81 ListDataIntegrationFlows .......................................................................................................................... 82 Request Syntax ...................................................................................................................................... 82 URI Request Parameters ...................................................................................................................... 82 Request Body ......................................................................................................................................... 82 Response Syntax ................................................................................................................................... 82 Response Elements ............................................................................................................................... 84 Errors ....................................................................................................................................................... 85 See Also .................................................................................................................................................. 86 ListDataLakeDatasets ................................................................................................................................. 87 Request Syntax ...................................................................................................................................... 87 URI Request Parameters ...................................................................................................................... 87 Request Body ......................................................................................................................................... 88 Response Syntax ................................................................................................................................... 88 Response Elements ............................................................................................................................... 89 Errors ....................................................................................................................................................... 89 See Also .................................................................................................................................................. 90 ListDataLakeNamespaces .......................................................................................................................... 92 Request Syntax ...................................................................................................................................... 92 URI Request Parameters ...................................................................................................................... 92 Request Body ......................................................................................................................................... 92 Response Syntax ................................................................................................................................... 93 Response Elements ............................................................................................................................... 93 Errors ....................................................................................................................................................... 94 See Also .................................................................................................................................................. 95 ListInstances ................................................................................................................................................ 96 Request Syntax ...................................................................................................................................... 96 URI Request Parameters ...................................................................................................................... 96 Request Body ......................................................................................................................................... 97 Response Syntax ................................................................................................................................... 97 Response Elements ............................................................................................................................... 97 Errors ....................................................................................................................................................... 98 See Also .................................................................................................................................................. 99 API Version 2024-01-01 vii AWS Supply Chain API Reference ListTagsForResource ................................................................................................................................ 100 Request Syntax .................................................................................................................................... 100 URI Request Parameters ................................................................................................................... 100 Request Body ....................................................................................................................................... 100 Response Syntax ................................................................................................................................. 100 Response Elements ............................................................................................................................ 101 Errors ..................................................................................................................................................... 101 See Also ................................................................................................................................................ 102 SendDataIntegrationEvent ..................................................................................................................... 103 Request Syntax .................................................................................................................................... 103 URI Request Parameters ................................................................................................................... 103 Request Body ....................................................................................................................................... 103 Response Syntax ................................................................................................................................. 106 Response Elements ............................................................................................................................ 106 Errors ..................................................................................................................................................... 106 See Also ................................................................................................................................................ 107 TagResource .............................................................................................................................................. 109 Request Syntax .................................................................................................................................... 109 URI Request Parameters ................................................................................................................... 109 Request Body ....................................................................................................................................... 109 Response Syntax ................................................................................................................................. 110 Response Elements ............................................................................................................................ 110 Errors ..................................................................................................................................................... 110 See Also ................................................................................................................................................ 111 UntagResource .......................................................................................................................................... 112 Request Syntax .................................................................................................................................... 112 URI Request Parameters ................................................................................................................... 112 Request Body ....................................................................................................................................... 112 Response Syntax ................................................................................................................................. 112 Response Elements ............................................................................................................................ 113 Errors ..................................................................................................................................................... 113 See Also ................................................................................................................................................ 114 UpdateDataIntegrationFlow .................................................................................................................. 115 Request Syntax .................................................................................................................................... 115 URI Request Parameters ................................................................................................................... 116 Request Body ....................................................................................................................................... 117 API Version 2024-01-01 viii AWS Supply Chain API Reference Response Syntax ................................................................................................................................. 118 Response Elements ............................................................................................................................ 119 Errors ..................................................................................................................................................... 120 See Also ................................................................................................................................................ 121 UpdateDataLakeDataset ......................................................................................................................... 122 Request Syntax .................................................................................................................................... 122 URI Request Parameters ................................................................................................................... 122 Request Body ....................................................................................................................................... 123 Response Syntax ................................................................................................................................. 123 Response Elements ............................................................................................................................ 124 Errors ..................................................................................................................................................... 125 See Also ................................................................................................................................................ 126 UpdateDataLakeNamespace .................................................................................................................. 127 Request Syntax .................................................................................................................................... 127 URI Request Parameters ................................................................................................................... 127 Request Body ....................................................................................................................................... 127 Response Syntax ................................................................................................................................. 128 Response Elements ............................................................................................................................ 128 Errors ..................................................................................................................................................... 128 See Also ................................................................................................................................................ 129 UpdateInstance ......................................................................................................................................... 131 Request Syntax .................................................................................................................................... 131 URI Request Parameters ................................................................................................................... 131 Request Body ....................................................................................................................................... 131 Response Syntax ................................................................................................................................. 132 Response Elements ............................................................................................................................ 132 Errors ..................................................................................................................................................... 133 See Also ................................................................................................................................................ 134 Data Types ................................................................................................................................... 135 BillOfMaterialsImportJob ....................................................................................................................... 137 Contents ............................................................................................................................................... 137 See Also ................................................................................................................................................ 138 DataIntegrationEvent .............................................................................................................................. 139 Contents ............................................................................................................................................... 139 See Also ................................................................................................................................................ 140 DataIntegrationEventDatasetLoadExecutionDetails ......................................................................... 141 API Version 2024-01-01 ix AWS Supply Chain API Reference Contents ............................................................................................................................................... 141 See Also ................................................................................................................................................ 141 DataIntegrationEventDatasetTargetConfiguration ............................................................................ 142 Contents ............................................................................................................................................... 142 See Also ................................................................................................................................................ 142 DataIntegrationEventDatasetTargetDetails ........................................................................................ 143 Contents ............................................................................................................................................... 143 See Also ................................................................................................................................................ 144 DataIntegrationFlow ................................................................................................................................ 145 Contents ............................................................................................................................................... 145 See Also ................................................................................................................................................ 146 DataIntegrationFlowDatasetOptions ................................................................................................... 147 Contents ............................................................................................................................................... 147 See Also ................................................................................................................................................ 148 DataIntegrationFlowDatasetSource ...................................................................................................... 149 Contents ............................................................................................................................................... 149 See Also ................................................................................................................................................ 149 DataIntegrationFlowDatasetSourceConfiguration ............................................................................. 150 Contents ............................................................................................................................................... 150 See Also ................................................................................................................................................ 150 DataIntegrationFlowDatasetTargetConfiguration ............................................................................. 151 Contents ............................................................................................................................................... 151 See Also ................................................................................................................................................ 151 DataIntegrationFlowDedupeStrategy .................................................................................................. 152 Contents ............................................................................................................................................... 152 See Also ................................................................................................................................................ 152 DataIntegrationFlowExecution .............................................................................................................. 153 Contents ............................................................................................................................................... 153 See Also ................................................................................................................................................ 155 DataIntegrationFlowExecutionOutputMetadata ................................................................................ 156 Contents ............................................................................................................................................... 156 See Also ................................................................................................................................................ 156 DataIntegrationFlowExecutionSourceInfo ........................................................................................... 157 Contents ............................................................................................................................................... 157 See Also ................................................................................................................................................ 157 DataIntegrationFlowFieldPriorityDedupeField ................................................................................... 158 API Version 2024-01-01 x AWS Supply Chain API Reference Contents ............................................................................................................................................... 158 See Also ................................................................................................................................................ 158 DataIntegrationFlowFieldPriorityDedupeStrategyConfiguration ................................................... 159 Contents ............................................................................................................................................... 159 See Also ................................................................................................................................................ 159 DataIntegrationFlowS3Options ............................................................................................................. 160 Contents ............................................................................................................................................... 160 See Also ................................................................................................................................................ 160 DataIntegrationFlowS3Source ............................................................................................................... 161 Contents ............................................................................................................................................... 161 See Also ................................................................................................................................................ 161 DataIntegrationFlowS3SourceConfiguration ...................................................................................... 162 Contents ............................................................................................................................................... 162 See Also ................................................................................................................................................ 162 DataIntegrationFlowS3TargetConfiguration ....................................................................................... 164 Contents ............................................................................................................................................... 164 See Also ................................................................................................................................................ 164 DataIntegrationFlowSource .................................................................................................................... 166 Contents ............................................................................................................................................... 166 See Also ................................................................................................................................................ 167 DataIntegrationFlowSQLTransformationConfiguration .................................................................... 168 Contents ............................................................................................................................................... 168 See Also ................................................................................................................................................ 168 DataIntegrationFlowTarget .................................................................................................................... 169 Contents ............................................................................................................................................... 169 See Also ................................................................................................................................................ 169 DataIntegrationFlowTransformation .................................................................................................... 171 Contents ............................................................................................................................................... 171 See Also ................................................................................................................................................ 171 DataLakeDataset ...................................................................................................................................... 172 Contents ............................................................................................................................................... 172 See Also ................................................................................................................................................ 174 DataLakeDatasetPartitionField .............................................................................................................. 175 Contents ............................................................................................................................................... 175 See Also ................................................................................................................................................ 175 DataLakeDatasetPartitionFieldTransform ........................................................................................... 176 API Version 2024-01-01 xi AWS Supply Chain API Reference Contents ............................................................................................................................................... 176 See Also ................................................................................................................................................ 176 DataLakeDatasetPartitionSpec .............................................................................................................. 177 Contents ............................................................................................................................................... 177 See Also ................................................................................................................................................ 177 DataLakeDatasetPrimaryKeyField ......................................................................................................... 178 Contents ............................................................................................................................................... 178 See Also ................................................................................................................................................ 178 DataLakeDatasetSchema ........................................................................................................................ 179 Contents ............................................................................................................................................... 179 See Also ................................................................................................................................................ 180 DataLakeDatasetSchemaField ............................................................................................................... 181 Contents ............................................................................................................................................... 181 See Also ................................................................................................................................................ 181 DataLakeNamespace ................................................................................................................................ 183 Contents ............................................................................................................................................... 183 See Also ................................................................................................................................................ 184 Instance ...................................................................................................................................................... 185 Contents ............................................................................................................................................... 185 See Also ................................................................................................................................................ 187 Common Parameters ................................................................................................................... 188 Common Errors ............................................................................................................................ 191 API Version 2024-01-01 xii AWS Supply Chain Welcome API Reference AWS Supply Chain is a cloud-based application that works with your
|
supply-chain-api-003
|
supply-chain-api.pdf
| 3 |
Supply Chain API Reference Contents ............................................................................................................................................... 176 See Also ................................................................................................................................................ 176 DataLakeDatasetPartitionSpec .............................................................................................................. 177 Contents ............................................................................................................................................... 177 See Also ................................................................................................................................................ 177 DataLakeDatasetPrimaryKeyField ......................................................................................................... 178 Contents ............................................................................................................................................... 178 See Also ................................................................................................................................................ 178 DataLakeDatasetSchema ........................................................................................................................ 179 Contents ............................................................................................................................................... 179 See Also ................................................................................................................................................ 180 DataLakeDatasetSchemaField ............................................................................................................... 181 Contents ............................................................................................................................................... 181 See Also ................................................................................................................................................ 181 DataLakeNamespace ................................................................................................................................ 183 Contents ............................................................................................................................................... 183 See Also ................................................................................................................................................ 184 Instance ...................................................................................................................................................... 185 Contents ............................................................................................................................................... 185 See Also ................................................................................................................................................ 187 Common Parameters ................................................................................................................... 188 Common Errors ............................................................................................................................ 191 API Version 2024-01-01 xii AWS Supply Chain Welcome API Reference AWS Supply Chain is a cloud-based application that works with your enterprise resource planning (ERP) and supply chain management systems. Using AWS Supply Chain, you can connect and extract your inventory, supply, and demand related data from existing ERP or supply chain systems into a single data model. The AWS Supply Chain API supports configuration data import for Supply Planning. All AWS Supply chain API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies. This document was last published on May 14, 2025. API Version 2024-01-01 1 AWS Supply Chain Actions The following actions are supported: • CreateBillOfMaterialsImportJob • CreateDataIntegrationFlow • CreateDataLakeDataset • CreateDataLakeNamespace • CreateInstance • DeleteDataIntegrationFlow • DeleteDataLakeDataset • DeleteDataLakeNamespace • DeleteInstance • GetBillOfMaterialsImportJob • GetDataIntegrationEvent • GetDataIntegrationFlow • GetDataIntegrationFlowExecution • GetDataLakeDataset • GetDataLakeNamespace • GetInstance • ListDataIntegrationEvents • ListDataIntegrationFlowExecutions • ListDataIntegrationFlows • ListDataLakeDatasets • ListDataLakeNamespaces • ListInstances • ListTagsForResource • SendDataIntegrationEvent • TagResource • UntagResource • UpdateDataIntegrationFlow API Reference API Version 2024-01-01 2 AWS Supply Chain • UpdateDataLakeDataset • UpdateDataLakeNamespace • UpdateInstance API Reference API Version 2024-01-01 3 AWS Supply Chain API Reference CreateBillOfMaterialsImportJob CreateBillOfMaterialsImportJob creates an import job for the Product Bill Of Materials (BOM) entity. For information on the product_bom entity, see the AWS Supply Chain User Guide. The CSV file must be located in an Amazon S3 location accessible to AWS Supply Chain. It is recommended to use the same Amazon S3 bucket created during your AWS Supply Chain instance creation. Request Syntax POST /api/configuration/instances/instanceId/bill-of-materials-import-jobs HTTP/1.1 Content-type: application/json { "clientToken": "string", "s3uri": "string" } URI Request Parameters The request uses the following URI parameters. instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes Request Body The request accepts the following data in JSON format. clientToken An idempotency token ensures the API request is only completed no more than once. This way, retrying the request will not trigger the operation multiple times. A client token is a unique, CreateBillOfMaterialsImportJob API Version 2024-01-01 4 AWS Supply Chain API Reference case-sensitive string of 33 to 128 ASCII characters. To make an idempotent API request, specify a client token in the request. You should not reuse the same client token for other requests. If you retry a successful request with the same client token, the request will succeed with no further actions being taken, and you will receive the same API response as the original successful request. Type: String Length Constraints: Minimum length of 33. Maximum length of 126. Required: No s3uri The S3 URI of the CSV file to be imported. The bucket must grant permissions for AWS Supply Chain to read the file. Type: String Length Constraints: Minimum length of 10. Pattern: [sS]3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.+ Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "jobId": "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. jobId The new BillOfMaterialsImportJob identifier. Response Syntax API Version 2024-01-01 5 AWS Supply Chain Type: String Length Constraints: Fixed length of 36. API Reference Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 Errors API Version 2024-01-01 6 AWS Supply Chain ValidationException API Reference The input does not satisfy the constraints specified by an AWS service. 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
|
supply-chain-api-004
|
supply-chain-api.pdf
| 4 |
would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 Errors API Version 2024-01-01 6 AWS Supply Chain ValidationException API Reference The input does not satisfy the constraints specified by an AWS service. 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 2024-01-01 7 AWS Supply Chain API Reference CreateDataIntegrationFlow Enables you to programmatically create a data pipeline to ingest data from source systems such as Amazon S3 buckets, to a predefined AWS Supply Chain dataset (product, inbound_order) or a temporary dataset along with the data transformation query provided with the API. Request Syntax PUT /api/data-integration/instance/instanceId/data-integration-flows/name HTTP/1.1 Content-type: application/json { "sources": [ { "datasetSource": { "datasetIdentifier": "string", "options": { "dedupeRecords": boolean, "dedupeStrategy": { "fieldPriority": { "fields": [ { "name": "string", "sortOrder": "string" } ] }, "type": "string" }, "loadType": "string" } }, "s3Source": { "bucketName": "string", "options": { "fileType": "string" }, "prefix": "string" }, "sourceName": "string", "sourceType": "string" } CreateDataIntegrationFlow API Version 2024-01-01 8 API Reference AWS Supply Chain ], "tags": { "string" : "string" }, "target": { "datasetTarget": { "datasetIdentifier": "string", "options": { "dedupeRecords": boolean, "dedupeStrategy": { "fieldPriority": { "fields": [ { "name": "string", "sortOrder": "string" } ] }, "type": "string" }, "loadType": "string" } }, "s3Target": { "bucketName": "string", "options": { "fileType": "string" }, "prefix": "string" }, "targetType": "string" }, "transformation": { "sqlTransformation": { "query": "string" }, "transformationType": "string" } } URI Request Parameters The request uses the following URI parameters. URI Request Parameters API Version 2024-01-01 9 AWS Supply Chain instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. API Reference Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes name Name of the DataIntegrationFlow. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9-]+ Required: Yes Request Body The request accepts the following data in JSON format. sources The source configurations for DataIntegrationFlow. Type: Array of DataIntegrationFlowSource objects Array Members: Minimum number of 1 item. Maximum number of 40 items. Required: Yes tags The tags of the DataIntegrationFlow to be created Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Request Body API Version 2024-01-01 10 AWS Supply Chain API Reference Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No target The target configurations for DataIntegrationFlow. Type: DataIntegrationFlowTarget object Required: Yes transformation The transformation configurations for DataIntegrationFlow. Type: DataIntegrationFlowTransformation object Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "instanceId": "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. instanceId The AWS Supply Chain instance identifier. Type: String Length Constraints: Fixed length of 36. Response Syntax API Version 2024-01-01 11 AWS Supply Chain API Reference Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} name The name of the DataIntegrationFlow created. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9-]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 Errors API Version 2024-01-01 12 AWS Supply Chain ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException API Reference The input does not satisfy the constraints specified by an AWS service. 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 2024-01-01 13 AWS Supply Chain API Reference CreateDataLakeDataset Enables you to programmatically create an AWS Supply Chain data lake dataset. Developers can create the datasets
|
supply-chain-api-005
|
supply-chain-api.pdf
| 5 |
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 2024-01-01 13 AWS Supply Chain API Reference CreateDataLakeDataset Enables you to programmatically create an AWS Supply Chain data lake dataset. Developers can create the datasets using their pre-defined or custom schema for a given instance ID, namespace, and dataset name. Request Syntax PUT /api/datalake/instance/instanceId/namespaces/namespace/datasets/name HTTP/1.1 Content-type: application/json { "description": "string", "partitionSpec": { "fields": [ { "name": "string", "transform": { "type": "string" } } ] }, "schema": { "fields": [ { "isRequired": boolean, "name": "string", "type": "string" } ], "name": "string", "primaryKeys": [ { "name": "string" } ] }, "tags": { "string" : "string" } } CreateDataLakeDataset API Version 2024-01-01 14 AWS Supply Chain API Reference URI Request Parameters The request uses the following URI parameters. instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes name The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model- asc.html. Length Constraints: Minimum length of 1. Maximum length of 75. Pattern: [a-z0-9_]+ Required: Yes namespace The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces: • asc - For information on the AWS Supply Chain supported datasets see https:// docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html. • default - For datasets with custom user-defined schemas. Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: [a-z0-9_]+ Required: Yes Request Body The request accepts the following data in JSON format. URI Request Parameters API Version 2024-01-01 15 AWS Supply Chain description The description of the dataset. Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 500. Required: No partitionSpec The partition specification of the dataset. Partitioning can effectively improve the dataset query performance by reducing the amount of data scanned during query execution. But partitioning or not will affect how data get ingested by data ingestion methods, such as SendDataIntegrationEvent's dataset UPSERT will upsert records within partition (instead of within whole dataset). For more details, refer to those data ingestion documentations. Type: DataLakeDatasetPartitionSpec object Required: No schema The custom schema of the data lake dataset and required for dataset in default and custom namespaces. Type: DataLakeDatasetSchema object Required: No tags The tags of the dataset. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No Request Body API Version 2024-01-01 16 API Reference AWS Supply Chain Response Syntax HTTP/1.1 200 Content-type: application/json { "dataset": { "arn": "string", "createdTime": number, "description": "string", "instanceId": "string", "lastModifiedTime": number, "name": "string", "namespace": "string", "partitionSpec": { "fields": [ { "name": "string", "transform": { "type": "string" } } ] }, "schema": { "fields": [ { "isRequired": boolean, "name": "string", "type": "string" } ], "name": "string", "primaryKeys": [ { "name": "string" } ] } } } Response Syntax API Version 2024-01-01 17 AWS Supply Chain 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. dataset The detail of created dataset. Type: DataLakeDataset object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 Response Elements API Version 2024-01-01 18 AWS Supply Chain ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException API Reference The input does not satisfy the constraints specified by an AWS service. 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
|
supply-chain-api-006
|
supply-chain-api.pdf
| 6 |
request throttling. HTTP Status Code: 429 ValidationException API Reference The input does not satisfy the constraints specified by an AWS service. 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 2024-01-01 19 AWS Supply Chain API Reference CreateDataLakeNamespace Enables you to programmatically create an AWS Supply Chain data lake namespace. Developers can create the namespaces for a given instance ID. Request Syntax PUT /api/datalake/instance/instanceId/namespaces/name HTTP/1.1 Content-type: application/json { "description": "string", "tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes name The name of the namespace. Noted you cannot create namespace with name starting with asc, default, scn, aws, amazon, amzn Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: [a-z0-9_]+ Required: Yes CreateDataLakeNamespace API Version 2024-01-01 20 API Reference AWS Supply Chain Request Body The request accepts the following data in JSON format. description The description of the namespace. Type: String Length Constraints: Minimum length of 1. Maximum length of 500. Required: No tags The tags of the namespace. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "namespace": { "arn": "string", "createdTime": number, "description": "string", "instanceId": "string", "lastModifiedTime": number, "name": "string" } } Request Body API Version 2024-01-01 21 AWS Supply Chain 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. namespace The detail of created namespace. Type: DataLakeNamespace object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 Response Elements API Version 2024-01-01 22 AWS Supply Chain ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException API Reference The input does not satisfy the constraints specified by an AWS service. 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 2024-01-01 23 AWS Supply Chain CreateInstance API Reference Enables you to programmatically create an AWS Supply Chain instance by applying KMS keys and relevant information associated with the API without using the AWS console. This is an asynchronous operation. Upon receiving a CreateInstance request, AWS Supply Chain immediately returns the instance resource, instance ID, and the initializing state while simultaneously creating all required AWS resources for an instance creation. You can use GetInstance to check the status of the instance. If the instance results in an unhealthy state, you need to check the error message, delete the current instance, and recreate a new one based on the mitigation from the error message. Request Syntax POST /api/instance HTTP/1.1 Content-type: application/json { "clientToken": "string", "instanceDescription": "string", "instanceName": "string", "kmsKeyArn": "string", "tags": { "string" : "string" }, "webAppDnsDomain": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. clientToken The client token for idempotency. Type: String CreateInstance API Version 2024-01-01 24 AWS Supply Chain API Reference Length Constraints: Minimum length of 33. Maximum length of 126. Required: No instanceDescription The AWS Supply Chain instance description. Type: String Length Constraints: Minimum length of 0. Maximum length of 501. Pattern: ([a-zA-Z0-9., _ʼ'%-]){0,500} Required: No instanceName The AWS Supply Chain instance name. Type: String Length Constraints: Minimum length of 0. Maximum
|
supply-chain-api-007
|
supply-chain-api.pdf
| 7 |
{ "string" : "string" }, "webAppDnsDomain": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. clientToken The client token for idempotency. Type: String CreateInstance API Version 2024-01-01 24 AWS Supply Chain API Reference Length Constraints: Minimum length of 33. Maximum length of 126. Required: No instanceDescription The AWS Supply Chain instance description. Type: String Length Constraints: Minimum length of 0. Maximum length of 501. Pattern: ([a-zA-Z0-9., _ʼ'%-]){0,500} Required: No instanceName The AWS Supply Chain instance name. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: (?![ _ʼ'%-])[a-zA-Z0-9 _ʼ'%-]{0,62}[a-zA-Z0-9] Required: No kmsKeyArn The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the AWS owned KMS key. If you don't provide anything here, AWS Supply Chain uses the AWS owned KMS key. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: arn:[a-z0-9][-.a-z0-9]{0,62}:kms:([a-z0-9][-.a-z0-9]{0,62})?:([a- z0-9][-.a-z0-9]{0,62})?:key/.{0,1019} Required: No tags The AWS tags of an instance to be created. Request Body API Version 2024-01-01 25 AWS Supply Chain Type: String to string map API Reference Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No webAppDnsDomain The DNS subdomain of the web app. This would be "example" in the URL "example.scn.global.on.aws". You can set this to a custom value, as long as the domain isn't already being used by someone else. The name may only include alphanumeric characters and hyphens. Type: String Pattern: (?![-])[a-zA-Z0-9-]{1,62}[a-zA-Z0-9] Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "instance": { "awsAccountId": "string", "createdTime": number, "errorMessage": "string", "instanceDescription": "string", "instanceId": "string", "instanceName": "string", "kmsKeyArn": "string", "lastModifiedTime": number, "state": "string", "versionNumber": number, "webAppDnsDomain": "string" } Response Syntax API Version 2024-01-01 26 AWS Supply Chain } 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. instance The AWS Supply Chain instance resource data details. Type: Instance object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. Response Elements API Version 2024-01-01 27 AWS Supply Chain HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException API Reference The input does not satisfy the constraints specified by an AWS service. 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 2024-01-01 28 AWS Supply Chain API Reference DeleteDataIntegrationFlow Enable you to programmatically delete an existing data pipeline for the provided AWS Supply Chain instance and DataIntegrationFlow name. Request Syntax DELETE /api/data-integration/instance/instanceId/data-integration-flows/name HTTP/1.1 URI Request Parameters The request uses the following URI parameters. instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes name The name of the DataIntegrationFlow to be deleted. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9-]+ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 DeleteDataIntegrationFlow API Version 2024-01-01 29 AWS Supply Chain API Reference Content-type: application/json { "instanceId": "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. instanceId The AWS Supply Chain instance identifier. Type: String Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} name The name of the DataIntegrationFlow deleted. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9-]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 Response Elements API Version 2024-01-01 30 AWS Supply Chain ConflictException API Reference Updating or deleting a resource can cause an inconsistent
|
supply-chain-api-008
|
supply-chain-api.pdf
| 8 |
following data is returned in JSON format by the service. instanceId The AWS Supply Chain instance identifier. Type: String Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} name The name of the DataIntegrationFlow deleted. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9-]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 Response Elements API Version 2024-01-01 30 AWS Supply Chain ConflictException API Reference Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input does not satisfy the constraints specified by an AWS service. 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++ See Also API Version 2024-01-01 31 AWS Supply Chain • 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 API Reference See Also API Version 2024-01-01 32 AWS Supply Chain API Reference DeleteDataLakeDataset Enables you to programmatically delete an AWS Supply Chain data lake dataset. Developers can delete the existing datasets for a given instance ID, namespace, and instance name. Request Syntax DELETE /api/datalake/instance/instanceId/namespaces/namespace/datasets/name HTTP/1.1 URI Request Parameters The request uses the following URI parameters. instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes name The name of the dataset. For asc namespace, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model- asc.html. Length Constraints: Minimum length of 1. Maximum length of 75. Pattern: [a-z0-9_]+ Required: Yes namespace The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces: • asc - For information on the AWS Supply Chain supported datasets see https:// docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html. • default - For datasets with custom user-defined schemas. DeleteDataLakeDataset API Version 2024-01-01 33 AWS Supply Chain API Reference Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: [a-z0-9_]+ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "instanceId": "string", "name": "string", "namespace": "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. instanceId The AWS Supply Chain instance identifier. Type: String Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} name The name of deleted dataset. Type: String Request Body API Version 2024-01-01 34 AWS Supply Chain API Reference Length Constraints: Minimum length of 1. Maximum length of 75. Pattern: [a-z0-9_]+ namespace The namespace of deleted dataset. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: [a-z0-9_]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. Errors API Version 2024-01-01 35 AWS Supply Chain HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException API Reference The input does not satisfy the constraints specified by an AWS service. 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 2024-01-01 36 AWS Supply Chain API Reference DeleteDataLakeNamespace Enables you to programmatically delete an AWS Supply Chain data lake namespace and its underling datasets. Developers can delete the existing namespaces for a given instance ID and namespace name. Request Syntax DELETE /api/datalake/instance/instanceId/namespaces/name HTTP/1.1 URI Request Parameters The request uses the following
|
supply-chain-api-009
|
supply-chain-api.pdf
| 9 |
• 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 2024-01-01 36 AWS Supply Chain API Reference DeleteDataLakeNamespace Enables you to programmatically delete an AWS Supply Chain data lake namespace and its underling datasets. Developers can delete the existing namespaces for a given instance ID and namespace name. Request Syntax DELETE /api/datalake/instance/instanceId/namespaces/name HTTP/1.1 URI Request Parameters The request uses the following URI parameters. instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes name The name of the namespace. Noted you cannot delete pre-defined namespace like asc, default which are only deleted through instance deletion. Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: [a-z0-9_]+ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 DeleteDataLakeNamespace API Version 2024-01-01 37 AWS Supply Chain API Reference Content-type: application/json { "instanceId": "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. instanceId The AWS Supply Chain instance identifier. Type: String Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} name The name of deleted namespace. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: [a-z0-9_]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 Response Elements API Version 2024-01-01 38 AWS Supply Chain ConflictException API Reference Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input does not satisfy the constraints specified by an AWS service. 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++ See Also API Version 2024-01-01 39 AWS Supply Chain • 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 API Reference See Also API Version 2024-01-01 40 AWS Supply Chain DeleteInstance API Reference Enables you to programmatically delete an AWS Supply Chain instance by deleting the KMS keys and relevant information associated with the API without using the AWS console. This is an asynchronous operation. Upon receiving a DeleteInstance request, AWS Supply Chain immediately returns a response with the instance resource, delete state while cleaning up all AWS resources created during the instance creation process. You can use the GetInstance action to check the instance status. Request Syntax DELETE /api/instance/instanceId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "instance": { "awsAccountId": "string", DeleteInstance API Version 2024-01-01 41 AWS Supply Chain API Reference "createdTime": number, "errorMessage": "string", "instanceDescription": "string", "instanceId": "string", "instanceName": "string", "kmsKeyArn": "string", "lastModifiedTime": number, "state": "string", "versionNumber": number, "webAppDnsDomain": "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. instance The AWS Supply Chain instance resource data details. Type: Instance object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. Response Elements API Version 2024-01-01 42 API Reference AWS Supply Chain HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input does not satisfy the constraints specified by an AWS service. HTTP Status Code: 400 See Also For more information about using this API
|
supply-chain-api-010
|
supply-chain-api.pdf
| 10 |
or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. Response Elements API Version 2024-01-01 42 API Reference AWS Supply Chain HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input does not satisfy the constraints specified by an AWS service. 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 2024-01-01 43 AWS Supply Chain API Reference See Also API Version 2024-01-01 44 AWS Supply Chain API Reference GetBillOfMaterialsImportJob Get status and details of a BillOfMaterialsImportJob. Request Syntax GET /api/configuration/instances/instanceId/bill-of-materials-import-jobs/jobId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes jobId The BillOfMaterialsImportJob identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 GetBillOfMaterialsImportJob API Version 2024-01-01 45 AWS Supply Chain API Reference Content-type: application/json { "job": { "instanceId": "string", "jobId": "string", "message": "string", "s3uri": "string", "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. job The BillOfMaterialsImportJob. Type: BillOfMaterialsImportJob object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. Response Elements API Version 2024-01-01 46 API Reference AWS Supply Chain HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input does not satisfy the constraints specified by an AWS service. 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 2024-01-01 47 AWS Supply Chain API Reference See Also API Version 2024-01-01 48 AWS Supply Chain API Reference GetDataIntegrationEvent Enables you to programmatically view an AWS Supply Chain Data Integration Event. Developers can view the eventType, eventGroupId, eventTimestamp, datasetTarget, datasetLoadExecution. Data integration event older than 30 days is not returned in the response. Request Syntax GET /api-data/data-integration/instance/instanceId/data-integration-events/eventId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. eventId The unique event identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 GetDataIntegrationEvent API Version 2024-01-01 49 AWS Supply Chain API Reference Content-type: application/json { "event": { "datasetTargetDetails": { "datasetIdentifier": "string", "datasetLoadExecution": { "message": "string", "status": "string" }, "operationType": "string" }, "eventGroupId": "string", "eventId": "string", "eventTimestamp": number, "eventType": "string", "instanceId": "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. event The details of the DataIntegrationEvent returned. Type: DataIntegrationEvent object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 Response Elements API Version 2024-01-01 50 AWS Supply Chain ConflictException API Reference Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status
|
supply-chain-api-011
|
supply-chain-api.pdf
| 11 |
of the DataIntegrationEvent returned. Type: DataIntegrationEvent object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 Response Elements API Version 2024-01-01 50 AWS Supply Chain ConflictException API Reference Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input does not satisfy the constraints specified by an AWS service. 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++ See Also API Version 2024-01-01 51 AWS Supply Chain • 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 API Reference See Also API Version 2024-01-01 52 AWS Supply Chain API Reference GetDataIntegrationFlow Enables you to programmatically view a specific data pipeline for the provided AWS Supply Chain instance and DataIntegrationFlow name. Request Syntax GET /api/data-integration/instance/instanceId/data-integration-flows/name HTTP/1.1 URI Request Parameters The request uses the following URI parameters. instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes name The name of the DataIntegrationFlow created. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9-]+ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { GetDataIntegrationFlow API Version 2024-01-01 53 AWS Supply Chain API Reference "flow": { "createdTime": number, "instanceId": "string", "lastModifiedTime": number, "name": "string", "sources": [ { "datasetSource": { "datasetIdentifier": "string", "options": { "dedupeRecords": boolean, "dedupeStrategy": { "fieldPriority": { "fields": [ { "name": "string", "sortOrder": "string" } ] }, "type": "string" }, "loadType": "string" } }, "s3Source": { "bucketName": "string", "options": { "fileType": "string" }, "prefix": "string" }, "sourceName": "string", "sourceType": "string" } ], "target": { "datasetTarget": { "datasetIdentifier": "string", "options": { "dedupeRecords": boolean, "dedupeStrategy": { "fieldPriority": { "fields": [ Response Syntax API Version 2024-01-01 54 AWS Supply Chain API Reference { "name": "string", "sortOrder": "string" } ] }, "type": "string" }, "loadType": "string" } }, "s3Target": { "bucketName": "string", "options": { "fileType": "string" }, "prefix": "string" }, "targetType": "string" }, "transformation": { "sqlTransformation": { "query": "string" }, "transformationType": "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. flow The details of the DataIntegrationFlow returned. Type: DataIntegrationFlow object Response Elements API Version 2024-01-01 55 AWS Supply Chain Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input does not satisfy the constraints specified by an AWS service. HTTP Status Code: 400 Errors API Version 2024-01-01 56 AWS Supply Chain 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 2024-01-01 57 AWS Supply Chain API Reference GetDataIntegrationFlowExecution Get the flow execution. Flow execution older than 1 year is not returned in the response. Request Syntax GET /api-data/data-integration/instance/instanceId/data-integration-flows/flowName/ executions/executionId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. executionId The flow execution identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes flowName The flow name. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9-]+ Required: Yes instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes GetDataIntegrationFlowExecution API Version 2024-01-01 58 API
|
supply-chain-api-012
|
supply-chain-api.pdf
| 12 |
See Also API Version 2024-01-01 57 AWS Supply Chain API Reference GetDataIntegrationFlowExecution Get the flow execution. Flow execution older than 1 year is not returned in the response. Request Syntax GET /api-data/data-integration/instance/instanceId/data-integration-flows/flowName/ executions/executionId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. executionId The flow execution identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes flowName The flow name. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9-]+ Required: Yes instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes GetDataIntegrationFlowExecution API Version 2024-01-01 58 API Reference AWS Supply Chain Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "flowExecution": { "endTime": number, "executionId": "string", "flowName": "string", "instanceId": "string", "message": "string", "outputMetadata": { "diagnosticReportsRootS3URI": "string" }, "sourceInfo": { "datasetSource": { "datasetIdentifier": "string" }, "s3Source": { "bucketName": "string", "key": "string" }, "sourceType": "string" }, "startTime": 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. flowExecution The flow execution details. Request Body API Version 2024-01-01 59 AWS Supply Chain API Reference Type: DataIntegrationFlowExecution object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input does not satisfy the constraints specified by an AWS service. HTTP Status Code: 400 Errors API Version 2024-01-01 60 AWS Supply Chain 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 2024-01-01 61 AWS Supply Chain API Reference GetDataLakeDataset Enables you to programmatically view an AWS Supply Chain data lake dataset. Developers can view the data lake dataset information such as namespace, schema, and so on for a given instance ID, namespace, and dataset name. Request Syntax GET /api/datalake/instance/instanceId/namespaces/namespace/datasets/name HTTP/1.1 URI Request Parameters The request uses the following URI parameters. instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes name The name of the dataset. For asc namespace, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model- asc.html. Length Constraints: Minimum length of 1. Maximum length of 75. Pattern: [a-z0-9_]+ Required: Yes namespace The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces: • asc - For information on the AWS Supply Chain supported datasets see https:// docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html. GetDataLakeDataset API Version 2024-01-01 62 AWS Supply Chain API Reference • default - For datasets with custom user-defined schemas. Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: [a-z0-9_]+ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "dataset": { "arn": "string", "createdTime": number, "description": "string", "instanceId": "string", "lastModifiedTime": number, "name": "string", "namespace": "string", "partitionSpec": { "fields": [ { "name": "string", "transform": { "type": "string" } } ] }, "schema": { "fields": [ { "isRequired": boolean, "name": "string", "type": "string" Request Body API Version 2024-01-01 63 API Reference AWS Supply Chain } ], "name": "string", "primaryKeys": [ { "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. dataset The fetched dataset details. Type: DataLakeDataset object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. Response Elements API Version 2024-01-01 64 API Reference AWS Supply Chain HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request
|
supply-chain-api-013
|
supply-chain-api.pdf
| 13 |
Type: DataLakeDataset object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. Response Elements API Version 2024-01-01 64 API Reference AWS Supply Chain HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input does not satisfy the constraints specified by an AWS service. 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 2024-01-01 65 AWS Supply Chain API Reference See Also API Version 2024-01-01 66 AWS Supply Chain API Reference GetDataLakeNamespace Enables you to programmatically view an AWS Supply Chain data lake namespace. Developers can view the data lake namespace information such as description for a given instance ID and namespace name. Request Syntax GET /api/datalake/instance/instanceId/namespaces/name HTTP/1.1 URI Request Parameters The request uses the following URI parameters. instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes name The name of the namespace. Besides the namespaces user created, you can also specify the pre- defined namespaces: • asc - Pre-defined namespace containing AWS Supply Chain supported datasets, see https:// docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html. • default - Pre-defined namespace containing datasets with custom user-defined schemas. Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: [a-z0-9_]+ Required: Yes Request Body The request does not have a request body. GetDataLakeNamespace API Version 2024-01-01 67 API Reference AWS Supply Chain Response Syntax HTTP/1.1 200 Content-type: application/json { "namespace": { "arn": "string", "createdTime": number, "description": "string", "instanceId": "string", "lastModifiedTime": number, "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. namespace The fetched namespace details. Type: DataLakeNamespace object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. Response Syntax API Version 2024-01-01 68 API Reference AWS Supply Chain HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input does not satisfy the constraints specified by an AWS service. 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 See Also API Version 2024-01-01 69 AWS Supply Chain • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2024-01-01 70 AWS Supply Chain GetInstance API Reference Enables you to programmatically retrieve the information related to an AWS Supply Chain instance ID. Request Syntax GET /api/instance/instanceId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. instanceId The AWS Supply Chain instance identifier Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "instance": { "awsAccountId": "string", "createdTime": number, "errorMessage": "string", "instanceDescription": "string", "instanceId": "string", "instanceName": "string", GetInstance API Version 2024-01-01 71 AWS Supply Chain API Reference "kmsKeyArn": "string", "lastModifiedTime": number, "state": "string", "versionNumber": number, "webAppDnsDomain": "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. instance The instance resource data details. Type: Instance object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required
|
supply-chain-api-014
|
supply-chain-api.pdf
| 14 |
Response Syntax HTTP/1.1 200 Content-type: application/json { "instance": { "awsAccountId": "string", "createdTime": number, "errorMessage": "string", "instanceDescription": "string", "instanceId": "string", "instanceName": "string", GetInstance API Version 2024-01-01 71 AWS Supply Chain API Reference "kmsKeyArn": "string", "lastModifiedTime": number, "state": "string", "versionNumber": number, "webAppDnsDomain": "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. instance The instance resource data details. Type: Instance object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. Response Elements API Version 2024-01-01 72 AWS Supply Chain API Reference HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input does not satisfy the constraints specified by an AWS service. 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 2024-01-01 73 AWS Supply Chain API Reference ListDataIntegrationEvents Enables you to programmatically list all data integration events for the provided AWS Supply Chain instance. Data integration events older than 30 days are not returned in the response. Request Syntax GET /api-data/data-integration/instance/instanceId/data-integration-events? eventType=eventType&maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. eventType List data integration events for the specified eventType. Valid Values: scn.data.forecast | scn.data.inventorylevel | scn.data.inboundorder | scn.data.inboundorderline | scn.data.inboundorderlineschedule | scn.data.outboundorderline | scn.data.outboundshipment | scn.data.processheader | scn.data.processoperation | scn.data.processproduct | scn.data.reservation | scn.data.shipment | scn.data.shipmentstop | scn.data.shipmentstoporder | scn.data.supplyplan | scn.data.dataset instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes maxResults Specify the maximum number of data integration events to fetch in one paginated request. Valid Range: Minimum value of 1. Maximum value of 20. ListDataIntegrationEvents API Version 2024-01-01 74 AWS Supply Chain nextToken API Reference The pagination token to fetch the next page of the data integration events. Length Constraints: Minimum length of 1. Maximum length of 65535. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "events": [ { "datasetTargetDetails": { "datasetIdentifier": "string", "datasetLoadExecution": { "message": "string", "status": "string" }, "operationType": "string" }, "eventGroupId": "string", "eventId": "string", "eventTimestamp": number, "eventType": "string", "instanceId": "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. Request Body API Version 2024-01-01 75 API Reference AWS Supply Chain events The list of data integration events. Type: Array of DataIntegrationEvent objects nextToken The pagination token to fetch the next page of the ListDataIntegrationEvents. Type: String Length Constraints: Minimum length of 1. Maximum length of 65535. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. Errors API Version 2024-01-01 76 AWS Supply Chain HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException API Reference The input does not satisfy the constraints specified by an AWS service. 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 2024-01-01 77 AWS Supply Chain API Reference ListDataIntegrationFlowExecutions List flow executions. Flow executions older than 1 year are not returned in the response. Request Syntax GET
|
supply-chain-api-015
|
supply-chain-api.pdf
| 15 |
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 2024-01-01 77 AWS Supply Chain API Reference ListDataIntegrationFlowExecutions List flow executions. Flow executions older than 1 year are not returned in the response. Request Syntax GET /api-data/data-integration/instance/instanceId/data-integration-flows/flowName/ executions?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. flowName The flow name. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9-]+ Required: Yes instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes maxResults The number to specify the max number of flow executions to fetch in this paginated request. Valid Range: Minimum value of 1. Maximum value of 20. nextToken The pagination token to fetch next page of flow executions. Length Constraints: Minimum length of 1. Maximum length of 65535. ListDataIntegrationFlowExecutions API Version 2024-01-01 78 API Reference AWS Supply Chain Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "flowExecutions": [ { "endTime": number, "executionId": "string", "flowName": "string", "instanceId": "string", "message": "string", "outputMetadata": { "diagnosticReportsRootS3URI": "string" }, "sourceInfo": { "datasetSource": { "datasetIdentifier": "string" }, "s3Source": { "bucketName": "string", "key": "string" }, "sourceType": "string" }, "startTime": number, "status": "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. Request Body API Version 2024-01-01 79 API Reference AWS Supply Chain flowExecutions The list of flow executions. Type: Array of DataIntegrationFlowExecution objects nextToken The pagination token to fetch next page of flow executions. Type: String Length Constraints: Minimum length of 1. Maximum length of 65535. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. Errors API Version 2024-01-01 80 AWS Supply Chain HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException API Reference The input does not satisfy the constraints specified by an AWS service. 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 2024-01-01 81 AWS Supply Chain API Reference ListDataIntegrationFlows Enables you to programmatically list all data pipelines for the provided AWS Supply Chain instance. Request Syntax GET /api/data-integration/instance/instanceId/data-integration-flows? maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes maxResults Specify the maximum number of DataIntegrationFlows to fetch in one paginated request. Valid Range: Minimum value of 0. Maximum value of 20. nextToken The pagination token to fetch the next page of the DataIntegrationFlows. Length Constraints: Minimum length of 1. Maximum length of 65535. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json ListDataIntegrationFlows API Version 2024-01-01 82 API Reference AWS Supply Chain { "flows": [ { "createdTime": number, "instanceId": "string", "lastModifiedTime": number, "name": "string", "sources": [ { "datasetSource": { "datasetIdentifier": "string", "options": { "dedupeRecords": boolean, "dedupeStrategy": { "fieldPriority": { "fields": [ { "name": "string", "sortOrder": "string" } ] }, "type": "string" }, "loadType": "string" } }, "s3Source": { "bucketName": "string", "options": { "fileType": "string" }, "prefix": "string" }, "sourceName": "string", "sourceType": "string" } ], "target": { "datasetTarget": { "datasetIdentifier": "string", "options": { "dedupeRecords": boolean, Response Syntax API Version 2024-01-01 83 AWS Supply Chain API Reference "dedupeStrategy": { "fieldPriority": { "fields": [ { "name": "string", "sortOrder": "string" } ] }, "type": "string" }, "loadType": "string" } }, "s3Target": { "bucketName": "string", "options": { "fileType": "string" }, "prefix": "string" }, "targetType": "string" }, "transformation": { "sqlTransformation": { "query": "string" }, "transformationType": "string" } } ], "nextToken": "string" }
|
supply-chain-api-016
|
supply-chain-api.pdf
| 16 |
} ] }, "type": "string" }, "loadType": "string" } }, "s3Source": { "bucketName": "string", "options": { "fileType": "string" }, "prefix": "string" }, "sourceName": "string", "sourceType": "string" } ], "target": { "datasetTarget": { "datasetIdentifier": "string", "options": { "dedupeRecords": boolean, Response Syntax API Version 2024-01-01 83 AWS Supply Chain API Reference "dedupeStrategy": { "fieldPriority": { "fields": [ { "name": "string", "sortOrder": "string" } ] }, "type": "string" }, "loadType": "string" } }, "s3Target": { "bucketName": "string", "options": { "fileType": "string" }, "prefix": "string" }, "targetType": "string" }, "transformation": { "sqlTransformation": { "query": "string" }, "transformationType": "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. flows The response parameters for ListDataIntegrationFlows. Response Elements API Version 2024-01-01 84 AWS Supply Chain API Reference Type: Array of DataIntegrationFlow objects nextToken The pagination token to fetch the next page of the DataIntegrationFlows. Type: String Length Constraints: Minimum length of 1. Maximum length of 65535. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. Errors API Version 2024-01-01 85 AWS Supply Chain HTTP Status Code: 429 ValidationException The input does not satisfy the constraints specified by an AWS service. API Reference 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 2024-01-01 86 AWS Supply Chain API Reference ListDataLakeDatasets Enables you to programmatically view the list of AWS Supply Chain data lake datasets. Developers can view the datasets and the corresponding information such as namespace, schema, and so on for a given instance ID and namespace. Request Syntax GET /api/datalake/instance/instanceId/namespaces/namespace/datasets? maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes maxResults The max number of datasets to fetch in this paginated request. Valid Range: Minimum value of 0. Maximum value of 20. namespace The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces: • asc - For information on the AWS Supply Chain supported datasets see https:// docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html. • default - For datasets with custom user-defined schemas. Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: [a-z0-9_]+ ListDataLakeDatasets API Version 2024-01-01 87 AWS Supply Chain Required: Yes nextToken API Reference The pagination token to fetch next page of datasets. Length Constraints: Minimum length of 1. Maximum length of 65535. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "datasets": [ { "arn": "string", "createdTime": number, "description": "string", "instanceId": "string", "lastModifiedTime": number, "name": "string", "namespace": "string", "partitionSpec": { "fields": [ { "name": "string", "transform": { "type": "string" } } ] }, "schema": { "fields": [ { "isRequired": boolean, "name": "string", "type": "string" Request Body API Version 2024-01-01 88 AWS Supply Chain API Reference } ], "name": "string", "primaryKeys": [ { "name": "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. datasets The list of fetched dataset details. Type: Array of DataLakeDataset objects Array Members: Minimum number of 0 items. Maximum number of 20 items. nextToken The pagination token to fetch next page of datasets. Type: String Length Constraints: Minimum length of 1. Maximum length of 65535. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. Response Elements API Version 2024-01-01 89 AWS Supply Chain HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. API Reference HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404
|
supply-chain-api-017
|
supply-chain-api.pdf
| 17 |
token to fetch next page of datasets. Type: String Length Constraints: Minimum length of 1. Maximum length of 65535. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. Response Elements API Version 2024-01-01 89 AWS Supply Chain HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. API Reference HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input does not satisfy the constraints specified by an AWS service. 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 See Also API Version 2024-01-01 90 API Reference AWS Supply Chain • 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 2024-01-01 91 AWS Supply Chain API Reference ListDataLakeNamespaces Enables you to programmatically view the list of AWS Supply Chain data lake namespaces. Developers can view the namespaces and the corresponding information such as description for a given instance ID. Note that this API only return custom namespaces, instance pre-defined namespaces are not included. Request Syntax GET /api/datalake/instance/instanceId/namespaces? maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes maxResults The max number of namespaces to fetch in this paginated request. Valid Range: Minimum value of 1. Maximum value of 20. nextToken The pagination token to fetch next page of namespaces. Length Constraints: Minimum length of 1. Maximum length of 65535. Request Body The request does not have a request body. ListDataLakeNamespaces API Version 2024-01-01 92 API Reference AWS Supply Chain Response Syntax HTTP/1.1 200 Content-type: application/json { "namespaces": [ { "arn": "string", "createdTime": number, "description": "string", "instanceId": "string", "lastModifiedTime": number, "name": "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. namespaces The list of fetched namespace details. Noted it only contains custom namespaces, pre-defined namespaces are not included. Type: Array of DataLakeNamespace objects Array Members: Minimum number of 1 item. Maximum number of 20 items. nextToken The pagination token to fetch next page of namespaces. Type: String Length Constraints: Minimum length of 1. Maximum length of 65535. Response Syntax API Version 2024-01-01 93 AWS Supply Chain Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input does not satisfy the constraints specified by an AWS service. HTTP Status Code: 400 Errors API Version 2024-01-01 94 AWS Supply Chain 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 2024-01-01 95 AWS Supply Chain ListInstances API Reference List all AWS Supply Chain instances for a specific account. Enables you to programmatically list all AWS Supply Chain instances based on their account ID, instance name, and state of the instance (active or delete). Request Syntax GET /api/instance? instanceNameFilter=instanceNameFilter&instanceStateFilter=instanceStateFilter&maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. instanceNameFilter The filter to ListInstances based on their names. Array Members: Minimum number of 0 items. Maximum number of 10 items. Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: (?![ _ʼ'%-])[a-zA-Z0-9 _ʼ'%-]{0,62}[a-zA-Z0-9] instanceStateFilter The filter to
|
supply-chain-api-018
|
supply-chain-api.pdf
| 18 |
API Version 2024-01-01 95 AWS Supply Chain ListInstances API Reference List all AWS Supply Chain instances for a specific account. Enables you to programmatically list all AWS Supply Chain instances based on their account ID, instance name, and state of the instance (active or delete). Request Syntax GET /api/instance? instanceNameFilter=instanceNameFilter&instanceStateFilter=instanceStateFilter&maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. instanceNameFilter The filter to ListInstances based on their names. Array Members: Minimum number of 0 items. Maximum number of 10 items. Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: (?![ _ʼ'%-])[a-zA-Z0-9 _ʼ'%-]{0,62}[a-zA-Z0-9] instanceStateFilter The filter to ListInstances based on their state. Array Members: Minimum number of 0 items. Maximum number of 6 items. Valid Values: Initializing | Active | CreateFailed | DeleteFailed | Deleting | Deleted maxResults Specify the maximum number of instances to fetch in this paginated request. Valid Range: Minimum value of 0. Maximum value of 20. nextToken The pagination token to fetch the next page of instances. ListInstances API Version 2024-01-01 96 AWS Supply Chain API Reference Length Constraints: Minimum length of 1. Maximum length of 1024. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "instances": [ { "awsAccountId": "string", "createdTime": number, "errorMessage": "string", "instanceDescription": "string", "instanceId": "string", "instanceName": "string", "kmsKeyArn": "string", "lastModifiedTime": number, "state": "string", "versionNumber": number, "webAppDnsDomain": "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. instances The list of instances resource data details. Type: Array of Instance objects Request Body API Version 2024-01-01 97 AWS Supply Chain nextToken API Reference The pagination token to fetch the next page of instances. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. Errors API Version 2024-01-01 98 AWS Supply Chain HTTP Status Code: 429 ValidationException The input does not satisfy the constraints specified by an AWS service. API Reference 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 2024-01-01 99 AWS Supply Chain API Reference ListTagsForResource List all the tags for an AWSSupply Chain resource. You can list all the tags added to a resource. By listing the tags, developers can view the tag level information on a resource and perform actions such as, deleting a resource associated with a particular tag. Request Syntax GET /api/tags/resourceArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn The AWS Supply chain resource ARN that needs tags to be listed. Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: arn:aws:scn(?::([a-z0-9-]+):([0-9]+):instance)?/([a-f0-9]{8}-[a- f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})[-_./A-Za-z0-9]* Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "tags": { "string" : "string" } } ListTagsForResource API Version 2024-01-01 100 AWS Supply Chain 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. tags The tags added to an AWS Supply Chain resource. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 Response Elements API Version 2024-01-01 101 AWS Supply Chain API Reference ServiceQuotaExceededException Request would cause a service quota to
|
supply-chain-api-019
|
supply-chain-api.pdf
| 19 |
Value Length Constraints: Minimum length of 0. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 Response Elements API Version 2024-01-01 101 AWS Supply Chain API Reference ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input does not satisfy the constraints specified by an AWS service. 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 2024-01-01 102 AWS Supply Chain API Reference SendDataIntegrationEvent Send the data payload for the event with real-time data for analysis or monitoring. The real-time data events are stored in an AWS service before being processed and stored in data lake. Request Syntax POST /api-data/data-integration/instance/instanceId/data-integration-events HTTP/1.1 Content-type: application/json { "clientToken": "string", "data": "string", "datasetTarget": { "datasetIdentifier": "string", "operationType": "string" }, "eventGroupId": "string", "eventTimestamp": number, "eventType": "string" } URI Request Parameters The request uses the following URI parameters. instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes Request Body The request accepts the following data in JSON format. SendDataIntegrationEvent API Version 2024-01-01 103 AWS Supply Chain clientToken API Reference The idempotent client token. The token is active for 8 hours, and within its lifetime, it ensures the request completes only once upon retry with same client token. If omitted, the AWS SDK generates a unique value so that AWS SDK can safely retry the request upon network errors. Type: String Length Constraints: Minimum length of 33. Maximum length of 126. Required: No data The data payload of the event, should follow the data schema of the target dataset, or see Data entities supported in AWS Supply Chain. To send single data record, use JsonObject format; to send multiple data records, use JsonArray format. Note that for AWS Supply Chain dataset under asc namespace, it has a connection_id internal field that is not allowed to be provided by client directly, they will be auto populated. Type: String Length Constraints: Minimum length of 1. Maximum length of 1048576. Required: Yes datasetTarget The target dataset configuration for scn.data.dataset event type. Type: DataIntegrationEventDatasetTargetConfiguration object Required: No eventGroupId Event identifier (for example, orderId for InboundOrder) used for data sharding or partitioning. Noted under one eventGroupId of same eventType and instanceId, events are processed sequentially in the order they are received by the server. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Request Body API Version 2024-01-01 104 AWS Supply Chain Required: Yes eventTimestamp API Reference The timestamp (in epoch seconds) associated with the event. If not provided, it will be assigned with current timestamp. Type: Timestamp Required: No eventType The data event type. • scn.data.dataset - Send data directly to any specified dataset. • scn.data.supplyplan - Send data to supply_plan dataset. • scn.data.shipmentstoporder - Send data to shipment_stop_order dataset. • scn.data.shipmentstop - Send data to shipment_stop dataset. • scn.data.shipment - Send data to shipment dataset. • scn.data.reservation - Send data to reservation dataset. • scn.data.processproduct - Send data to process_product dataset. • scn.data.processoperation - Send data to process_operation dataset. • scn.data.processheader - Send data to process_header dataset. • scn.data.forecast - Send data to forecast dataset. • scn.data.inventorylevel - Send data to inv_level dataset. • scn.data.inboundorder - Send data to inbound_order dataset. • scn.data.inboundorderline - Send data to inbound_order_line dataset. • scn.data.inboundorderlineschedule - Send data to inbound_order_line_schedule dataset. • scn.data.outboundorderline - Send data to outbound_order_line dataset. • scn.data.outboundshipment - Send data to outbound_shipment dataset. Type: String Valid Values: scn.data.forecast | scn.data.inventorylevel | scn.data.inboundorder | scn.data.inboundorderline | scn.data.inboundorderlineschedule | scn.data.outboundorderline | scn.data.outboundshipment | scn.data.processheader | Request Body API Version 2024-01-01 105 AWS Supply Chain API Reference scn.data.processoperation | scn.data.processproduct | scn.data.reservation | scn.data.shipment | scn.data.shipmentstop | scn.data.shipmentstoporder | scn.data.supplyplan | scn.data.dataset Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "eventId": "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. eventId The unique event identifier.
|
supply-chain-api-020
|
supply-chain-api.pdf
| 20 |
to outbound_order_line dataset. • scn.data.outboundshipment - Send data to outbound_shipment dataset. Type: String Valid Values: scn.data.forecast | scn.data.inventorylevel | scn.data.inboundorder | scn.data.inboundorderline | scn.data.inboundorderlineschedule | scn.data.outboundorderline | scn.data.outboundshipment | scn.data.processheader | Request Body API Version 2024-01-01 105 AWS Supply Chain API Reference scn.data.processoperation | scn.data.processproduct | scn.data.reservation | scn.data.shipment | scn.data.shipmentstop | scn.data.shipmentstoporder | scn.data.supplyplan | scn.data.dataset Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "eventId": "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. eventId The unique event identifier. Type: String Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 Response Syntax API Version 2024-01-01 106 AWS Supply Chain ConflictException API Reference Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input does not satisfy the constraints specified by an AWS service. 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++ See Also API Version 2024-01-01 107 AWS Supply Chain • 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 API Reference See Also API Version 2024-01-01 108 AWS Supply Chain TagResource API Reference You can create tags during or after creating a resource such as instance, data flow, or dataset in AWS Supply chain. During the data ingestion process, you can add tags such as dev, test, or prod to data flows created during the data ingestion process in the AWS Supply Chain datasets. You can use these tags to identify a group of resources or a single resource used by the developer. Request Syntax POST /api/tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. resourceArn The AWS Supply chain resource ARN that needs to be tagged. Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: arn:aws:scn(?::([a-z0-9-]+):([0-9]+):instance)?/([a-f0-9]{8}-[a- f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})[-_./A-Za-z0-9]* Required: Yes Request Body The request accepts the following data in JSON format. tags The tags of the AWS Supply chain resource to be created. TagResource API Version 2024-01-01 109 AWS Supply Chain Type: String to string map API Reference Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: Yes Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. Response Syntax API Version 2024-01-01 110 AWS Supply Chain API Reference HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input does not satisfy the constraints specified by an AWS service. 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 2024-01-01 111 AWS Supply Chain UntagResource API Reference You can delete tags for an AWS Supply chain resource such as instance, data flow, or dataset in AWS Supply Chain. During the data ingestion process, you can delete tags such as dev, test, or prod to data flows
|
supply-chain-api-021
|
supply-chain-api.pdf
| 21 |
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 2024-01-01 111 AWS Supply Chain UntagResource API Reference You can delete tags for an AWS Supply chain resource such as instance, data flow, or dataset in AWS Supply Chain. During the data ingestion process, you can delete tags such as dev, test, or prod to data flows created during the data ingestion process in the AWS Supply Chain datasets. Request Syntax DELETE /api/tags/resourceArn?tagKeys=tagKeys HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn The AWS Supply chain resource ARN that needs to be untagged. Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: arn:aws:scn(?::([a-z0-9-]+):([0-9]+):instance)?/([a-f0-9]{8}-[a- f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})[-_./A-Za-z0-9]* Required: Yes tagKeys The list of tag keys to be deleted for an AWS Supply Chain resource. Array Members: Minimum number of 0 items. Maximum number of 200 items. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 UntagResource API Version 2024-01-01 112 AWS Supply Chain Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input does not satisfy the constraints specified by an AWS service. Response Elements API Version 2024-01-01 113 AWS Supply Chain 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 2024-01-01 114 AWS Supply Chain API Reference UpdateDataIntegrationFlow Enables you to programmatically update an existing data pipeline to ingest data from the source systems such as, Amazon S3 buckets, to a predefined AWS Supply Chain dataset (product, inbound_order) or a temporary dataset along with the data transformation query provided with the API. Request Syntax PATCH /api/data-integration/instance/instanceId/data-integration-flows/name HTTP/1.1 Content-type: application/json { "sources": [ { "datasetSource": { "datasetIdentifier": "string", "options": { "dedupeRecords": boolean, "dedupeStrategy": { "fieldPriority": { "fields": [ { "name": "string", "sortOrder": "string" } ] }, "type": "string" }, "loadType": "string" } }, "s3Source": { "bucketName": "string", "options": { "fileType": "string" }, "prefix": "string" }, "sourceName": "string", "sourceType": "string" UpdateDataIntegrationFlow API Version 2024-01-01 115 API Reference AWS Supply Chain } ], "target": { "datasetTarget": { "datasetIdentifier": "string", "options": { "dedupeRecords": boolean, "dedupeStrategy": { "fieldPriority": { "fields": [ { "name": "string", "sortOrder": "string" } ] }, "type": "string" }, "loadType": "string" } }, "s3Target": { "bucketName": "string", "options": { "fileType": "string" }, "prefix": "string" }, "targetType": "string" }, "transformation": { "sqlTransformation": { "query": "string" }, "transformationType": "string" } } URI Request Parameters The request uses the following URI parameters. URI Request Parameters API Version 2024-01-01 116 AWS Supply Chain instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. API Reference Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes name The name of the DataIntegrationFlow to be updated. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9-]+ Required: Yes Request Body The request accepts the following data in JSON format. sources The new source configurations for the DataIntegrationFlow. Type: Array of DataIntegrationFlowSource objects Array Members: Minimum number of 1 item. Maximum number of 40 items. Required: No target The new target configurations for the DataIntegrationFlow. Type: DataIntegrationFlowTarget object Required: No transformation The new transformation configurations for the DataIntegrationFlow. Request Body API Version 2024-01-01 117 AWS Supply Chain API Reference Type: DataIntegrationFlowTransformation object Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "flow": { "createdTime": number, "instanceId": "string", "lastModifiedTime": number, "name": "string", "sources": [ { "datasetSource": { "datasetIdentifier": "string", "options": { "dedupeRecords": boolean, "dedupeStrategy": { "fieldPriority": { "fields": [ { "name": "string", "sortOrder": "string" } ] }, "type": "string" }, "loadType": "string"
|
supply-chain-api-022
|
supply-chain-api.pdf
| 22 |
DataIntegrationFlowSource objects Array Members: Minimum number of 1 item. Maximum number of 40 items. Required: No target The new target configurations for the DataIntegrationFlow. Type: DataIntegrationFlowTarget object Required: No transformation The new transformation configurations for the DataIntegrationFlow. Request Body API Version 2024-01-01 117 AWS Supply Chain API Reference Type: DataIntegrationFlowTransformation object Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "flow": { "createdTime": number, "instanceId": "string", "lastModifiedTime": number, "name": "string", "sources": [ { "datasetSource": { "datasetIdentifier": "string", "options": { "dedupeRecords": boolean, "dedupeStrategy": { "fieldPriority": { "fields": [ { "name": "string", "sortOrder": "string" } ] }, "type": "string" }, "loadType": "string" } }, "s3Source": { "bucketName": "string", "options": { "fileType": "string" }, "prefix": "string" }, "sourceName": "string", Response Syntax API Version 2024-01-01 118 AWS Supply Chain API Reference "sourceType": "string" } ], "target": { "datasetTarget": { "datasetIdentifier": "string", "options": { "dedupeRecords": boolean, "dedupeStrategy": { "fieldPriority": { "fields": [ { "name": "string", "sortOrder": "string" } ] }, "type": "string" }, "loadType": "string" } }, "s3Target": { "bucketName": "string", "options": { "fileType": "string" }, "prefix": "string" }, "targetType": "string" }, "transformation": { "sqlTransformation": { "query": "string" }, "transformationType": "string" } } } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Elements API Version 2024-01-01 119 AWS Supply Chain API Reference The following data is returned in JSON format by the service. flow The details of the updated DataIntegrationFlow. Type: DataIntegrationFlow object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. Errors API Version 2024-01-01 120 AWS Supply Chain HTTP Status Code: 429 ValidationException The input does not satisfy the constraints specified by an AWS service. API Reference 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 2024-01-01 121 AWS Supply Chain API Reference UpdateDataLakeDataset Enables you to programmatically update an AWS Supply Chain data lake dataset. Developers can update the description of a data lake dataset for a given instance ID, namespace, and dataset name. Request Syntax PATCH /api/datalake/instance/instanceId/namespaces/namespace/datasets/name HTTP/1.1 Content-type: application/json { "description": "string" } URI Request Parameters The request uses the following URI parameters. instanceId The AWS Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes name The name of the dataset. For asc namespace, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model- asc.html. Length Constraints: Minimum length of 1. Maximum length of 75. Pattern: [a-z0-9_]+ Required: Yes UpdateDataLakeDataset API Version 2024-01-01 122 AWS Supply Chain namespace API Reference The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces: • asc - For information on the AWS Supply Chain supported datasets see https:// docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html. • default - For datasets with custom user-defined schemas. Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: [a-z0-9_]+ Required: Yes Request Body The request accepts the following data in JSON format. description The updated description of the data lake dataset. Type: String Length Constraints: Minimum length of 1. Maximum length of 500. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "dataset": { "arn": "string", "createdTime": number, "description": "string", "instanceId": "string", Request Body API Version 2024-01-01 123 AWS Supply Chain API Reference "lastModifiedTime": number, "name": "string", "namespace": "string", "partitionSpec": { "fields": [ { "name": "string", "transform": { "type": "string" } } ] }, "schema": { "fields": [ { "isRequired": boolean, "name": "string", "type": "string" } ], "name": "string", "primaryKeys": [ { "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. dataset The updated dataset details. Type: DataLakeDataset object Response Elements API Version 2024-01-01 124 AWS Supply Chain Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException
|
supply-chain-api-023
|
supply-chain-api.pdf
| 23 |
"fields": [ { "isRequired": boolean, "name": "string", "type": "string" } ], "name": "string", "primaryKeys": [ { "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. dataset The updated dataset details. Type: DataLakeDataset object Response Elements API Version 2024-01-01 124 AWS Supply Chain Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input does not satisfy the constraints specified by an AWS service. HTTP Status Code: 400 Errors API Version 2024-01-01 125 AWS Supply Chain 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 2024-01-01 126 AWS Supply Chain API Reference UpdateDataLakeNamespace Enables you to programmatically update an AWS Supply Chain data lake namespace. Developers can update the description of a data lake namespace for a given instance ID and namespace name. Request Syntax PATCH /api/datalake/instance/instanceId/namespaces/name HTTP/1.1 Content-type: application/json { "description": "string" } URI Request Parameters The request uses the following URI parameters. instanceId The AWS Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes name The name of the namespace. Noted you cannot update namespace with name starting with asc, default, scn, aws, amazon, amzn Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: [a-z0-9_]+ Required: Yes Request Body The request accepts the following data in JSON format. UpdateDataLakeNamespace API Version 2024-01-01 127 AWS Supply Chain description API Reference The updated description of the data lake namespace. Type: String Length Constraints: Minimum length of 1. Maximum length of 500. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "namespace": { "arn": "string", "createdTime": number, "description": "string", "instanceId": "string", "lastModifiedTime": number, "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. namespace The updated namespace details. Type: DataLakeNamespace object Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2024-01-01 128 AWS Supply Chain AccessDeniedException API Reference You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input does not satisfy the constraints specified by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2024-01-01 129 API Reference AWS Supply Chain • 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 2024-01-01 130 AWS Supply Chain UpdateInstance API Reference Enables you to programmatically update an AWS Supply Chain instance description by providing all the relevant information such as account ID, instance ID and so on without using the AWS console. Request Syntax PATCH /api/instance/instanceId HTTP/1.1 Content-type: application/json { "instanceDescription": "string", "instanceName": "string" } URI Request Parameters The request uses the following URI parameters. instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes Request Body The request accepts the following data in JSON format. instanceDescription The AWS Supply Chain instance description. Type: String Length Constraints: Minimum length of 0. Maximum length
|
supply-chain-api-024
|
supply-chain-api.pdf
| 24 |
Reference Enables you to programmatically update an AWS Supply Chain instance description by providing all the relevant information such as account ID, instance ID and so on without using the AWS console. Request Syntax PATCH /api/instance/instanceId HTTP/1.1 Content-type: application/json { "instanceDescription": "string", "instanceName": "string" } URI Request Parameters The request uses the following URI parameters. instanceId The AWS Supply Chain instance identifier. Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes Request Body The request accepts the following data in JSON format. instanceDescription The AWS Supply Chain instance description. Type: String Length Constraints: Minimum length of 0. Maximum length of 501. UpdateInstance API Version 2024-01-01 131 AWS Supply Chain API Reference Pattern: ([a-zA-Z0-9., _ʼ'%-]){0,500} Required: No instanceName The AWS Supply Chain instance name. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: (?![ _ʼ'%-])[a-zA-Z0-9 _ʼ'%-]{0,62}[a-zA-Z0-9] Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "instance": { "awsAccountId": "string", "createdTime": number, "errorMessage": "string", "instanceDescription": "string", "instanceId": "string", "instanceName": "string", "kmsKeyArn": "string", "lastModifiedTime": number, "state": "string", "versionNumber": number, "webAppDnsDomain": "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 2024-01-01 132 API Reference AWS Supply Chain instance The instance resource data details. Type: Instance object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have the required privileges to perform this action. HTTP Status Code: 403 ConflictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 Errors API Version 2024-01-01 133 AWS Supply Chain ValidationException API Reference The input does not satisfy the constraints specified by an AWS service. 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 2024-01-01 134 AWS Supply Chain Data Types API Reference The AWS Supply Chain 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: • BillOfMaterialsImportJob • DataIntegrationEvent • DataIntegrationEventDatasetLoadExecutionDetails • DataIntegrationEventDatasetTargetConfiguration • DataIntegrationEventDatasetTargetDetails • DataIntegrationFlow • DataIntegrationFlowDatasetOptions • DataIntegrationFlowDatasetSource • DataIntegrationFlowDatasetSourceConfiguration • DataIntegrationFlowDatasetTargetConfiguration • DataIntegrationFlowDedupeStrategy • DataIntegrationFlowExecution • DataIntegrationFlowExecutionOutputMetadata • DataIntegrationFlowExecutionSourceInfo • DataIntegrationFlowFieldPriorityDedupeField • DataIntegrationFlowFieldPriorityDedupeStrategyConfiguration • DataIntegrationFlowS3Options • DataIntegrationFlowS3Source • DataIntegrationFlowS3SourceConfiguration • DataIntegrationFlowS3TargetConfiguration API Version 2024-01-01 135 AWS Supply Chain • DataIntegrationFlowSource • DataIntegrationFlowSQLTransformationConfiguration API Reference • DataIntegrationFlowTarget • DataIntegrationFlowTransformation • DataLakeDataset • DataLakeDatasetPartitionField • DataLakeDatasetPartitionFieldTransform • DataLakeDatasetPartitionSpec • DataLakeDatasetPrimaryKeyField • DataLakeDatasetSchema • DataLakeDatasetSchemaField • DataLakeNamespace • Instance API Version 2024-01-01 136 AWS Supply Chain API Reference BillOfMaterialsImportJob The BillOfMaterialsImportJob details. Contents instanceId The BillOfMaterialsImportJob instanceId. Type: String Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes jobId The BillOfMaterialsImportJob jobId. Type: String Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes s3uri The S3 URI from which the CSV is read. Type: String Length Constraints: Minimum length of 10. Pattern: [sS]3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.+ Required: Yes status The BillOfMaterialsImportJob ConfigurationJobStatus. BillOfMaterialsImportJob API Version 2024-01-01 137 AWS Supply Chain Type: String API Reference Valid Values: NEW | FAILED | IN_PROGRESS | QUEUED | SUCCESS Required: Yes message When the BillOfMaterialsImportJob has reached a terminal state, there will be a message. Type: String Required: No 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 See Also API Version 2024-01-01 138 AWS Supply Chain API Reference DataIntegrationEvent The data integration event details. Contents eventGroupId Event identifier (for example, orderId for InboundOrder) used for data sharding or partitioning. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes eventId The unique event identifier. Type: String Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes eventTimestamp The event timestamp (in epoch seconds). Type: Timestamp Required: Yes eventType The data event type. Type: String Valid Values: scn.data.forecast | scn.data.inventorylevel | scn.data.inboundorder | scn.data.inboundorderline | DataIntegrationEvent API Version 2024-01-01
|
supply-chain-api-025
|
supply-chain-api.pdf
| 25 |
AWS SDK for Ruby V3 See Also API Version 2024-01-01 138 AWS Supply Chain API Reference DataIntegrationEvent The data integration event details. Contents eventGroupId Event identifier (for example, orderId for InboundOrder) used for data sharding or partitioning. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes eventId The unique event identifier. Type: String Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes eventTimestamp The event timestamp (in epoch seconds). Type: Timestamp Required: Yes eventType The data event type. Type: String Valid Values: scn.data.forecast | scn.data.inventorylevel | scn.data.inboundorder | scn.data.inboundorderline | DataIntegrationEvent API Version 2024-01-01 139 AWS Supply Chain API Reference scn.data.inboundorderlineschedule | scn.data.outboundorderline | scn.data.outboundshipment | scn.data.processheader | scn.data.processoperation | scn.data.processproduct | scn.data.reservation | scn.data.shipment | scn.data.shipmentstop | scn.data.shipmentstoporder | scn.data.supplyplan | scn.data.dataset Required: Yes instanceId The AWS Supply Chain instance identifier. Type: String Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes datasetTargetDetails The target dataset details for a DATASET event type. Type: DataIntegrationEventDatasetTargetDetails object Required: No 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 See Also API Version 2024-01-01 140 AWS Supply Chain API Reference DataIntegrationEventDatasetLoadExecutionDetails The target dataset load execution details. Contents status The event load execution status to target dataset. Type: String Valid Values: SUCCEEDED | IN_PROGRESS | FAILED Required: Yes message The failure message (if any) of failed event load execution to dataset. Type: String Required: No 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 DataIntegrationEventDatasetLoadExecutionDetails API Version 2024-01-01 141 AWS Supply Chain API Reference DataIntegrationEventDatasetTargetConfiguration The target dataset configuration for a DATASET event type. Contents datasetIdentifier The datalake dataset ARN identifier. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: arn:aws:scn:([a-z0-9-]+):([0-9]+):instance/([a-f0-9]{8}-[a-f0-9] {4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})/namespaces/[^/]+/datasets/ [^/]+ Required: Yes operationType The target dataset load operation type. Type: String Valid Values: APPEND | UPSERT | DELETE Required: Yes 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 DataIntegrationEventDatasetTargetConfiguration API Version 2024-01-01 142 AWS Supply Chain API Reference DataIntegrationEventDatasetTargetDetails The target dataset details for a DATASET event type. Contents datasetIdentifier The datalake dataset ARN identifier. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: arn:aws:scn:([a-z0-9-]+):([0-9]+):instance/([a-f0-9]{8}-[a-f0-9] {4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})/namespaces/[^/]+/datasets/ [^/]+ Required: Yes datasetLoadExecution The target dataset load execution. Type: DataIntegrationEventDatasetLoadExecutionDetails object Required: Yes operationType The target dataset load operation type. The available options are: • APPEND - Add new records to the dataset. Noted that this operation type will just try to append records as-is without any primary key or partition constraints. • UPSERT - Modify existing records in the dataset with primary key configured, events for datasets without primary keys are not allowed. If event data contains primary keys that match records in the dataset within same partition, then those existing records (in that partition) will be updated. If primary keys do not match, new records will be added. Note that if dataset contain records with duplicate primary key values in the same partition, those duplicate records will be deduped into one updated record. • DELETE - Remove existing records in the dataset with primary key configured, events for datasets without primary keys are not allowed. If event data contains primary keys that DataIntegrationEventDatasetTargetDetails API Version 2024-01-01 143 AWS Supply Chain API Reference match records in the dataset within same partition, then those existing records (in that partition) will be deleted. If primary keys do not match, no actions will be done. Note that if dataset contain records with duplicate primary key values in the same partition, all those duplicates will be removed. Type: String Valid Values: APPEND | UPSERT | DELETE Required: Yes 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 See Also API Version 2024-01-01 144 AWS Supply Chain API Reference DataIntegrationFlow The DataIntegrationFlow details. Contents createdTime The DataIntegrationFlow creation timestamp. Type: Timestamp Required: Yes instanceId The DataIntegrationFlow instance ID. Type: String Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes lastModifiedTime The DataIntegrationFlow last modified timestamp. Type: Timestamp Required: Yes name The DataIntegrationFlow name. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9-]+ Required: Yes DataIntegrationFlow API Version 2024-01-01 145 AWS Supply Chain sources The DataIntegrationFlow source configurations. Type: Array of DataIntegrationFlowSource objects Array Members: Minimum number
|
supply-chain-api-026
|
supply-chain-api.pdf
| 26 |
• AWS SDK for Ruby V3 See Also API Version 2024-01-01 144 AWS Supply Chain API Reference DataIntegrationFlow The DataIntegrationFlow details. Contents createdTime The DataIntegrationFlow creation timestamp. Type: Timestamp Required: Yes instanceId The DataIntegrationFlow instance ID. Type: String Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes lastModifiedTime The DataIntegrationFlow last modified timestamp. Type: Timestamp Required: Yes name The DataIntegrationFlow name. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9-]+ Required: Yes DataIntegrationFlow API Version 2024-01-01 145 AWS Supply Chain sources The DataIntegrationFlow source configurations. Type: Array of DataIntegrationFlowSource objects Array Members: Minimum number of 1 item. Maximum number of 40 items. API Reference Required: Yes target The DataIntegrationFlow target configuration. Type: DataIntegrationFlowTarget object Required: Yes transformation The DataIntegrationFlow transformation configurations. Type: DataIntegrationFlowTransformation object Required: Yes 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 See Also API Version 2024-01-01 146 AWS Supply Chain API Reference DataIntegrationFlowDatasetOptions The dataset options used in dataset source and target configurations. Contents dedupeRecords The option to perform deduplication on data records sharing same primary key values. If disabled, transformed data with duplicate primary key values will ingest into dataset, for datasets within asc namespace, such duplicates will cause ingestion fail. If enabled without dedupeStrategy, deduplication is done by retaining a random data record among those sharing the same primary key values. If enabled with dedupeStragtegy, the deduplication is done following the strategy. Note that target dataset may have partition configured, when dedupe is enabled, it only dedupe against primary keys and retain only one record out of those duplicates regardless of its partition status. Type: Boolean Required: No dedupeStrategy The deduplication strategy to dedupe the data records sharing same primary key values of the target dataset. This strategy only applies to target dataset with primary keys and with dedupeRecords option enabled. If transformed data still got duplicates after the dedupeStrategy evaluation, a random data record is chosen to be retained. Type: DataIntegrationFlowDedupeStrategy object Required: No loadType The target dataset's data load type. This only affects how source S3 files are selected in the S3- to-dataset flow. • REPLACE - Target dataset will get replaced with the new file added under the source s3 prefix. DataIntegrationFlowDatasetOptions API Version 2024-01-01 147 AWS Supply Chain API Reference • INCREMENTAL - Target dataset will get updated with the up-to-date content under S3 prefix incorporating any file additions or removals there. Type: String Valid Values: INCREMENTAL | REPLACE Required: No 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 See Also API Version 2024-01-01 148 AWS Supply Chain API Reference DataIntegrationFlowDatasetSource The details of a flow execution with dataset source. Contents datasetIdentifier The ARN of the dataset source. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: arn:aws:scn:([a-z0-9-]+):([0-9]+):instance/([a-f0-9]{8}-[a-f0-9] {4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})/namespaces/[^/]+/datasets/ [^/]+ Required: Yes 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 DataIntegrationFlowDatasetSource API Version 2024-01-01 149 AWS Supply Chain API Reference DataIntegrationFlowDatasetSourceConfiguration The dataset DataIntegrationFlow source configuration parameters. Contents datasetIdentifier The ARN of the dataset. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: [-_/A-Za-z0-9:]+ Required: Yes options The dataset DataIntegrationFlow source options. Type: DataIntegrationFlowDatasetOptions object Required: No 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 DataIntegrationFlowDatasetSourceConfiguration API Version 2024-01-01 150 AWS Supply Chain API Reference DataIntegrationFlowDatasetTargetConfiguration The dataset DataIntegrationFlow target configuration parameters. Contents datasetIdentifier The dataset ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: [-_/A-Za-z0-9:]+ Required: Yes options The dataset DataIntegrationFlow target options. Type: DataIntegrationFlowDatasetOptions object Required: No 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 DataIntegrationFlowDatasetTargetConfiguration API Version 2024-01-01 151 AWS Supply Chain API Reference DataIntegrationFlowDedupeStrategy The deduplication strategy details. Contents type The type of the deduplication strategy. • FIELD_PRIORITY - Field priority configuration for the deduplication strategy specifies an ordered list of fields used to tie-break the data records sharing the same primary key values. Fields earlier in the list have higher priority for evaluation. For each field, the sort order determines whether to retain data record with larger
|
supply-chain-api-027
|
supply-chain-api.pdf
| 27 |
of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DataIntegrationFlowDatasetTargetConfiguration API Version 2024-01-01 151 AWS Supply Chain API Reference DataIntegrationFlowDedupeStrategy The deduplication strategy details. Contents type The type of the deduplication strategy. • FIELD_PRIORITY - Field priority configuration for the deduplication strategy specifies an ordered list of fields used to tie-break the data records sharing the same primary key values. Fields earlier in the list have higher priority for evaluation. For each field, the sort order determines whether to retain data record with larger or smaller field value. Type: String Valid Values: FIELD_PRIORITY Required: Yes fieldPriority The field priority deduplication strategy. Type: DataIntegrationFlowFieldPriorityDedupeStrategyConfiguration object Required: No 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 DataIntegrationFlowDedupeStrategy API Version 2024-01-01 152 AWS Supply Chain API Reference DataIntegrationFlowExecution The flow execution details. Contents executionId The flow executionId. Type: String Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes flowName The flow execution's flowName. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9-]+ Required: Yes instanceId The flow execution's instanceId. Type: String Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes endTime The flow execution end timestamp. DataIntegrationFlowExecution API Version 2024-01-01 153 API Reference AWS Supply Chain Type: Timestamp Required: No message The failure message (if any) of failed flow execution. Type: String Required: No outputMetadata The flow execution output metadata. Type: DataIntegrationFlowExecutionOutputMetadata object Required: No sourceInfo The source information for a flow execution. Type: DataIntegrationFlowExecutionSourceInfo object Required: No startTime The flow execution start timestamp. Type: Timestamp Required: No status The status of flow execution. Type: String Valid Values: SUCCEEDED | IN_PROGRESS | FAILED Required: No Contents API Version 2024-01-01 154 AWS Supply Chain 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 2024-01-01 155 AWS Supply Chain API Reference DataIntegrationFlowExecutionOutputMetadata The output metadata of the flow execution. Contents diagnosticReportsRootS3URI The S3 URI under which all diagnostic files (such as deduped records if any) are stored. Type: String Pattern: s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.{1,1024} Required: No 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 DataIntegrationFlowExecutionOutputMetadata API Version 2024-01-01 156 AWS Supply Chain API Reference DataIntegrationFlowExecutionSourceInfo The source information of a flow execution. Contents sourceType The data integration flow execution source type. Type: String Valid Values: S3 | DATASET Required: Yes datasetSource The source details of a flow execution with dataset source. Type: DataIntegrationFlowDatasetSource object Required: No s3Source The source details of a flow execution with S3 source. Type: DataIntegrationFlowS3Source object Required: No 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 DataIntegrationFlowExecutionSourceInfo API Version 2024-01-01 157 AWS Supply Chain API Reference DataIntegrationFlowFieldPriorityDedupeField The field used in the field priority deduplication strategy. Contents name The name of the deduplication field. Must exist in the dataset and not be a primary key. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: [a-z0-9_]+ Required: Yes sortOrder The sort order for the deduplication field. Type: String Valid Values: ASC | DESC Required: Yes 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 DataIntegrationFlowFieldPriorityDedupeField API Version 2024-01-01 158 AWS Supply Chain API Reference DataIntegrationFlowFieldPriorityDedupeStrategyConfiguration The field priority deduplication strategy details. Contents fields The list of field names and their sort order for deduplication, arranged in descending priority from highest to lowest. Type: Array of DataIntegrationFlowFieldPriorityDedupeField objects Array Members: Minimum number of 1 item. Maximum number of 10 items. Required: Yes 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 DataIntegrationFlowFieldPriorityDedupeStrategyConfiguration API Version 2024-01-01 159 AWS Supply Chain API Reference DataIntegrationFlowS3Options The Amazon S3 options used in S3 source and target configurations. Contents fileType The Amazon S3 file type in S3 options. Type: String Valid Values: CSV | PARQUET | JSON Required: No See Also For more information about using this API in one of the language-specific
|
supply-chain-api-028
|
supply-chain-api.pdf
| 28 |
Maximum number of 10 items. Required: Yes 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 DataIntegrationFlowFieldPriorityDedupeStrategyConfiguration API Version 2024-01-01 159 AWS Supply Chain API Reference DataIntegrationFlowS3Options The Amazon S3 options used in S3 source and target configurations. Contents fileType The Amazon S3 file type in S3 options. Type: String Valid Values: CSV | PARQUET | JSON Required: No 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 DataIntegrationFlowS3Options API Version 2024-01-01 160 AWS Supply Chain API Reference DataIntegrationFlowS3Source The details of a flow execution with S3 source. Contents bucketName The S3 bucket name of the S3 source. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: [a-z0-9][a-z0-9.-]*[a-z0-9] Required: Yes key The S3 object key of the S3 source. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [/A-Za-z0-9._:*()'!=?&+;@-]+ Required: Yes 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 DataIntegrationFlowS3Source API Version 2024-01-01 161 AWS Supply Chain API Reference DataIntegrationFlowS3SourceConfiguration The S3 DataIntegrationFlow source configuration parameters. Contents bucketName The bucketName of the S3 source objects. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: [a-z0-9][a-z0-9.-]*[a-z0-9] Required: Yes prefix The prefix of the S3 source objects. To trigger data ingestion, S3 files need to be put under s3://bucketName/prefix/. Type: String Length Constraints: Minimum length of 0. Maximum length of 700. Pattern: [/A-Za-z0-9._-]+ Required: Yes options The other options of the S3 DataIntegrationFlow source. Type: DataIntegrationFlowS3Options object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: DataIntegrationFlowS3SourceConfiguration API Version 2024-01-01 162 AWS Supply Chain • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2024-01-01 163 AWS Supply Chain API Reference DataIntegrationFlowS3TargetConfiguration The S3 DataIntegrationFlow target configuration parameters. Contents bucketName The bucketName of the S3 target objects. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: [a-z0-9][a-z0-9.-]*[a-z0-9] Required: Yes prefix The prefix of the S3 target objects. Type: String Length Constraints: Minimum length of 0. Maximum length of 700. Pattern: [/A-Za-z0-9._-]+ Required: Yes options The S3 DataIntegrationFlow target options. Type: DataIntegrationFlowS3Options object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: DataIntegrationFlowS3TargetConfiguration API Version 2024-01-01 164 AWS Supply Chain • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2024-01-01 165 AWS Supply Chain API Reference DataIntegrationFlowSource The DataIntegrationFlow source parameters. Contents sourceName The DataIntegrationFlow source name that can be used as table alias in SQL transformation query. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_]+ Required: Yes sourceType The DataIntegrationFlow source type. Type: String Valid Values: S3 | DATASET Required: Yes datasetSource The dataset DataIntegrationFlow source. Type: DataIntegrationFlowDatasetSourceConfiguration object Required: No s3Source The S3 DataIntegrationFlow source. Type: DataIntegrationFlowS3SourceConfiguration object Required: No DataIntegrationFlowSource API Version 2024-01-01 166 AWS Supply Chain 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 2024-01-01 167 AWS Supply Chain API Reference DataIntegrationFlowSQLTransformationConfiguration The SQL DataIntegrationFlow transformation configuration parameters. Contents query The transformation SQL query body based on SparkSQL. Type: String Length Constraints: Minimum length of 1. Maximum length of 65535. Required: Yes 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 DataIntegrationFlowSQLTransformationConfiguration API Version 2024-01-01 168 AWS Supply Chain API Reference DataIntegrationFlowTarget The DataIntegrationFlow target parameters. Contents targetType The DataIntegrationFlow target type. Type: String Valid Values: S3 | DATASET Required: Yes datasetTarget The dataset DataIntegrationFlow target. Note that for AWS Supply Chain dataset under asc namespace, it has a connection_id internal field that is not allowed to be provided by client directly, they will be auto populated. Type: DataIntegrationFlowDatasetTargetConfiguration object Required: No s3Target The S3 DataIntegrationFlow target. Type: DataIntegrationFlowS3TargetConfiguration object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS
|
supply-chain-api-029
|
supply-chain-api.pdf
| 29 |
Version 2024-01-01 168 AWS Supply Chain API Reference DataIntegrationFlowTarget The DataIntegrationFlow target parameters. Contents targetType The DataIntegrationFlow target type. Type: String Valid Values: S3 | DATASET Required: Yes datasetTarget The dataset DataIntegrationFlow target. Note that for AWS Supply Chain dataset under asc namespace, it has a connection_id internal field that is not allowed to be provided by client directly, they will be auto populated. Type: DataIntegrationFlowDatasetTargetConfiguration object Required: No s3Target The S3 DataIntegrationFlow target. Type: DataIntegrationFlowS3TargetConfiguration object Required: No 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 DataIntegrationFlowTarget API Version 2024-01-01 169 AWS Supply Chain API Reference See Also API Version 2024-01-01 170 AWS Supply Chain API Reference DataIntegrationFlowTransformation The DataIntegrationFlow transformation parameters. Contents transformationType The DataIntegrationFlow transformation type. Type: String Valid Values: SQL | NONE Required: Yes sqlTransformation The SQL DataIntegrationFlow transformation configuration. Type: DataIntegrationFlowSQLTransformationConfiguration object Required: No 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 DataIntegrationFlowTransformation API Version 2024-01-01 171 API Reference AWS Supply Chain DataLakeDataset The data lake dataset details. Contents arn The arn of the dataset. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: arn:aws:scn(?::([a-z0-9-]+):([0-9]+):instance)?/([a-f0-9]{8}-[a- f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})[-_./A-Za-z0-9]* Required: Yes createdTime The creation time of the dataset. Type: Timestamp Required: Yes instanceId The AWS Supply Chain instance identifier. Type: String Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes lastModifiedTime The last modified time of the dataset. Type: Timestamp DataLakeDataset API Version 2024-01-01 172 AWS Supply Chain Required: Yes name API Reference The name of the dataset. For asc namespace, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model- asc.html. Type: String Length Constraints: Minimum length of 1. Maximum length of 75. Pattern: [a-z0-9_]+ Required: Yes namespace The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces: • asc - For information on the AWS Supply Chain supported datasets see https:// docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html. • default - For datasets with custom user-defined schemas. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: [a-z0-9_]+ Required: Yes schema The schema of the dataset. Type: DataLakeDatasetSchema object Required: Yes description The description of the dataset. Type: String Contents API Version 2024-01-01 173 AWS Supply Chain API Reference Length Constraints: Minimum length of 1. Maximum length of 500. Required: No partitionSpec The partition specification for a dataset. Type: DataLakeDatasetPartitionSpec object Required: No 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 See Also API Version 2024-01-01 174 AWS Supply Chain API Reference DataLakeDatasetPartitionField The detail of the partition field. Contents name The name of the partition field. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: [a-z0-9_]+ Required: Yes transform The transformation of the partition field. A transformation specifies how to partition on a given field. For example, with timestamp you can specify that you'd like to partition fields by day, e.g. data record with value 2025-01-03T00:00:00Z in partition field is in 2025-01-03 partition. Also noted that data record without any value in optional partition field is in NULL partition. Type: DataLakeDatasetPartitionFieldTransform object Required: Yes 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 DataLakeDatasetPartitionField API Version 2024-01-01 175 AWS Supply Chain API Reference DataLakeDatasetPartitionFieldTransform The detail of the partition field transformation. Contents type The type of partitioning transformation for this field. The available options are: • IDENTITY - Partitions data on a given field by its exact values. • YEAR - Partitions data on a timestamp field using year granularity. • MONTH - Partitions data on a timestamp field using month granularity. • DAY - Partitions data on a timestamp field using day granularity. • HOUR - Partitions data on a timestamp field using hour granularity. Type: String Valid Values: YEAR | MONTH | DAY | HOUR | IDENTITY Required: Yes 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 DataLakeDatasetPartitionFieldTransform API Version 2024-01-01 176 AWS Supply Chain API Reference DataLakeDatasetPartitionSpec The partition specification for a dataset. Contents fields The fields on which to partition a dataset. The partitions will be applied
|
supply-chain-api-030
|
supply-chain-api.pdf
| 30 |
timestamp field using day granularity. • HOUR - Partitions data on a timestamp field using hour granularity. Type: String Valid Values: YEAR | MONTH | DAY | HOUR | IDENTITY Required: Yes 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 DataLakeDatasetPartitionFieldTransform API Version 2024-01-01 176 AWS Supply Chain API Reference DataLakeDatasetPartitionSpec The partition specification for a dataset. Contents fields The fields on which to partition a dataset. The partitions will be applied hierarchically based on the order of this list. Type: Array of DataLakeDatasetPartitionField objects Array Members: Minimum number of 1 item. Maximum number of 10 items. Required: Yes 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 DataLakeDatasetPartitionSpec API Version 2024-01-01 177 AWS Supply Chain API Reference DataLakeDatasetPrimaryKeyField The detail of the primary key field. Contents name The name of the primary key field. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: [a-z0-9_]+ Required: Yes 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 DataLakeDatasetPrimaryKeyField API Version 2024-01-01 178 AWS Supply Chain API Reference DataLakeDatasetSchema The schema details of the dataset. Note that for AWS Supply Chain dataset under asc namespace, it may have internal fields like connection_id that will be auto populated by data ingestion methods. Contents fields The list of field details of the dataset schema. Type: Array of DataLakeDatasetSchemaField objects Array Members: Minimum number of 1 item. Maximum number of 500 items. Required: Yes name The name of the dataset schema. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: [A-Za-z0-9]+ Required: Yes primaryKeys The list of primary key fields for the dataset. Primary keys defined can help data ingestion methods to ensure data uniqueness: CreateDataIntegrationFlow's dedupe strategy will leverage primary keys to perform records deduplication before write to dataset; SendDataIntegrationEvent's UPSERT and DELETE can only work with dataset with primary keys. For more details, refer to those data ingestion documentations. Note that defining primary keys does not necessarily mean the dataset cannot have duplicate records, duplicate records can still be ingested if CreateDataIntegrationFlow's dedupe disabled or through SendDataIntegrationEvent's APPEND operation. Type: Array of DataLakeDatasetPrimaryKeyField objects DataLakeDatasetSchema API Version 2024-01-01 179 AWS Supply Chain API Reference Array Members: Minimum number of 1 item. Maximum number of 20 items. Required: No 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 See Also API Version 2024-01-01 180 AWS Supply Chain API Reference DataLakeDatasetSchemaField The dataset field details. Contents isRequired Indicate if the field is required or not. Type: Boolean Required: Yes name The dataset field name. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: [a-z0-9_]+ Required: Yes type The dataset field type. Type: String Valid Values: INT | DOUBLE | STRING | TIMESTAMP | LONG Required: Yes 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 DataLakeDatasetSchemaField API Version 2024-01-01 181 AWS Supply Chain • AWS SDK for Ruby V3 API Reference See Also API Version 2024-01-01 182 AWS Supply Chain API Reference DataLakeNamespace The data lake namespace details. Contents arn The arn of the namespace. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: arn:aws:scn(?::([a-z0-9-]+):([0-9]+):instance)?/([a-f0-9]{8}-[a- f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})[-_./A-Za-z0-9]* Required: Yes createdTime The creation time of the namespace. Type: Timestamp Required: Yes instanceId The AWS Supply Chain instance identifier. Type: String Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes lastModifiedTime The last modified time of the namespace. Type: Timestamp DataLakeNamespace API Version 2024-01-01 183 AWS Supply Chain Required: Yes name The name of the namespace. Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: [a-z0-9_]+ Required: Yes description The description of the namespace. Type: String Length Constraints: Minimum length of 1. Maximum length of 500. Required: No 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 See Also API Version 2024-01-01 184 API Reference AWS Supply Chain Instance The details of the instance. Contents awsAccountId The AWS
|
supply-chain-api-031
|
supply-chain-api.pdf
| 31 |
The name of the namespace. Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: [a-z0-9_]+ Required: Yes description The description of the namespace. Type: String Length Constraints: Minimum length of 1. Maximum length of 500. Required: No 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 See Also API Version 2024-01-01 184 API Reference AWS Supply Chain Instance The details of the instance. Contents awsAccountId The AWS account ID that owns the instance. Type: String Pattern: [0-9]{12} Required: Yes instanceId The AWS Supply Chain instance identifier. Type: String Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes state The state of the instance. Type: String Valid Values: Initializing | Active | CreateFailed | DeleteFailed | Deleting | Deleted Required: Yes createdTime The instance creation timestamp. Type: Timestamp Instance API Version 2024-01-01 185 AWS Supply Chain Required: No errorMessage API Reference The AWS Supply Chain instance error message. If the instance results in an unhealthy state, customers need to check the error message, delete the current instance, and recreate a new one based on the mitigation from the error message. Type: String Required: No instanceDescription The AWS Supply Chain instance description. Type: String Length Constraints: Minimum length of 0. Maximum length of 501. Pattern: ([a-zA-Z0-9., _ʼ'%-]){0,500} Required: No instanceName The AWS Supply Chain instance name. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: (?![ _ʼ'%-])[a-zA-Z0-9 _ʼ'%-]{0,62}[a-zA-Z0-9] Required: No kmsKeyArn The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you optionally provided for encryption. If you did not provide anything here, AWS Supply Chain uses the AWS owned KMS key and nothing is returned. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Contents API Version 2024-01-01 186 AWS Supply Chain API Reference Pattern: arn:[a-z0-9][-.a-z0-9]{0,62}:kms:([a-z0-9][-.a-z0-9]{0,62})?:([a- z0-9][-.a-z0-9]{0,62})?:key/.{0,1019} Required: No lastModifiedTime The instance last modified timestamp. Type: Timestamp Required: No versionNumber The version number of the instance. Type: Double Required: No webAppDnsDomain The WebApp DNS domain name of the instance. Type: String Pattern: (?![-])[a-zA-Z0-9-]{1,62}[a-zA-Z0-9] Required: No 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 See Also API Version 2024-01-01 187 AWS Supply Chain 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 2024-01-01 188 AWS Supply Chain 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
|
supply-chain-api-032
|
supply-chain-api.pdf
| 32 |
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 2024-01-01 189 AWS Supply Chain 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 2024-01-01 190 AWS Supply Chain 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: 403 ExpiredTokenException The security token included in the request is expired HTTP Status Code: 403 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 403 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 MalformedHttpRequestException Problems with the request at the HTTP level, e.g. we can't decompress the body according to the decompression algorithm specified by the content-encoding. HTTP Status Code: 400 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 401 OptInRequired The AWS access key ID needs a subscription for the service. API Version 2024-01-01 191 AWS Supply Chain HTTP Status Code: 403 RequestAbortedException API Reference Convenient exception that can be used when a request is aborted before a reply is sent back (e.g. client closed connection). HTTP Status Code: 400 RequestEntityTooLargeException Problems with the request at the HTTP level. The request entity is too large. HTTP Status Code: 413 RequestExpired 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 RequestTimeoutException Problems with the request at the HTTP level. Reading the Request timed out. HTTP Status Code: 408 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 UnrecognizedClientException The X.509 certificate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 API Version 2024-01-01 192 AWS Supply Chain UnknownOperationException API Reference The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 404 ValidationError The input fails to satisfy the constraints specified by an AWS service. HTTP Status Code: 400 API Version 2024-01-01 193
|
supplychain-ag-001
|
supplychain-ag.pdf
| 1 |
Administrator Guide AWS Supply Chain Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. AWS Supply Chain Administrator Guide AWS Supply Chain: Administrator 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 Supply Chain Table of Contents Administrator Guide What is AWS Supply Chain? ............................................................................................................ 1 Supported browsers ..................................................................................................................................... 1 Supported languages ................................................................................................................................... 1 .................................................................................................................................................................... 1 Setting up an AWS account ............................................................................................................ 3 Sign up for an AWS account ...................................................................................................................... 3 Create a user with administrative access ................................................................................................ 3 Prerequisites to use AWS Supply Chain ......................................................................................... 6 Getting started with AWS Supply Chain ........................................................................................ 7 Step 1: Assign an IAM Identity Center User profile .............................................................................. 7 Step 2: Create an instance ......................................................................................................................... 8 Use standard configuration ................................................................................................................... 9 Use advanced configuration ............................................................................................................... 11 Step 3: Choose an AWS Supply Chain application owner ................................................................. 17 Log on to AWS Supply Chain web application .................................................................................... 19 Using the AWS Supply Chain ........................................................................................................ 20 Using AWS Supply Chain console ........................................................................................................... 20 Updating your profile ................................................................................................................................ 24 Updating your account profile ........................................................................................................... 25 Updating your organization profile .................................................................................................. 25 Managing user permission roles ............................................................................................................. 25 Adding users .......................................................................................................................................... 26 Updating user permissions ................................................................................................................. 27 Deleting users ........................................................................................................................................ 27 Creating custom user permission roles ............................................................................................ 28 Deleting an instance .................................................................................................................................. 28 Security .......................................................................................................................................... 30 Data protection ........................................................................................................................................... 31 Data handled by AWS Supply Chain ................................................................................................. 32 Opt-out preference ............................................................................................................................... 32 Encryption at rest ................................................................................................................................. 32 Encryption in transit ............................................................................................................................ 32 Key management .................................................................................................................................. 33 Inter-network traffic privacy .............................................................................................................. 33 iii AWS Supply Chain Administrator Guide How AWS Supply Chain uses grants in AWS KMS ......................................................................... 33 AWS PrivateLink ......................................................................................................................................... 37 Considerations ....................................................................................................................................... 37 Create an interface endpoint ............................................................................................................. 37 Create an endpoint policy .................................................................................................................. 38 IAM ................................................................................................................................................................ 39 Audience .................................................................................................................................................. 39 Authenticating with identities ............................................................................................................ 40 Managing access using policies .......................................................................................................... 43 How AWS Supply Chain works with IAM ......................................................................................... 46 Identity-based policy examples ......................................................................................................... 51 Troubleshooting .................................................................................................................................... 52 AWS managed policies .............................................................................................................................. 54 AWSSupplyChainFederationAdminAccess ........................................................................................ 55 Policy updates ....................................................................................................................................... 56 Compliance validation ............................................................................................................................... 57 Resilience ...................................................................................................................................................... 58 Logging and Monitoring AWS Supply Chain ........................................................................................ 58 AWS Supply Chain data events in CloudTrail ................................................................................. 59 AWS Supply Chain management events in CloudTrail .................................................................. 61 Web application APIs ........................................................................................................................... 61 Managing events using EventBridge ...................................................................................................... 67 AWS Supply Chain events ................................................................................................................... 68 Sending AWS Supply Chain events ................................................................................................... 68 Events detail reference ........................................................................................................................ 69 Quotas ............................................................................................................................................ 71 Frequently asked questions (FAQs) .............................................................................................. 73 Administrative support ................................................................................................................. 75 Document history .......................................................................................................................... 76 iv AWS Supply Chain Administrator Guide What is AWS Supply Chain? AWS Supply Chain is a cloud-based supply chain management application that unifies data and provides ML-powered forecasting methods to improve demand forecasting and inventory visibility, actionable insights, built-in contextual collaboration, demand planning, supply planning, n-tier supplier visibility, and sustainability information management. AWS Supply Chain can connect to your existing enterprise resource planning (ERP) and supply chain management systems and uses ML and generative AI to transform and integrate disparate data into the supply chain data lake (SCDL). AWS Supply Chain can improve supply chain risk management without replatforming, upfront licensing fees, or long-term commitments. Topics • Browsers supported by AWS Supply Chain • Languages supported by AWS Supply Chain Browsers supported by AWS Supply Chain Before you work with AWS Supply Chain, verify that your browser is supported using the following table. Browser Google Chrome Mozilla Firefox ESR Supported Versions Latest three versions. Versions are supported until their Firefox end- of-life date. For details, see the Firefox ESR release calendar. Mozilla Firefox Latest three versions. Microsoft Edge and Edge Chromium Version 84 and later. Safari Safari 10 or later on macOS. Languages supported by AWS Supply Chain Supported browsers 1 AWS Supply Chain Administrator Guide AWS Supply Chain supports the following languages: • English (US) • English (UK) • German • Spanish • French • Italian • Portuguese • Chinese (Simplified) • Chinese (Traditional) • Japanese • Korean Supported languages 2 AWS Supply Chain Administrator Guide Setting up an AWS account Use this section to create an AWS account and create an IAM user. For information on best practices to create an AWS account, see Establishing your best practice AWS environment. Topics • Sign up for an AWS account • Create a user with administrative access Sign up for an AWS account If you do not have an AWS account, complete the following steps to create
|
supplychain-ag-002
|
supplychain-ag.pdf
| 2 |
English (UK) • German • Spanish • French • Italian • Portuguese • Chinese (Simplified) • Chinese (Traditional) • Japanese • Korean Supported languages 2 AWS Supply Chain Administrator Guide Setting up an AWS account Use this section to create an AWS account and create an IAM user. For information on best practices to create an AWS account, see Establishing your best practice AWS environment. Topics • Sign up for an AWS account • Create a user with administrative access Sign up for an AWS account If you do not have an AWS account, complete the following steps to create one. To sign up for an AWS account 1. Open https://portal.aws.amazon.com/billing/signup. 2. Follow the online instructions. Part of the sign-up procedure involves receiving a phone call and entering a verification code on the phone keypad. When you sign up for an AWS account, an AWS account root user is created. The root user has access to all AWS services and resources in the account. As a security best practice, assign administrative access to a user, and use only the root user to perform tasks that require root user access. AWS sends you a confirmation email after the sign-up process is complete. At any time, you can view your current account activity and manage your account by going to https://aws.amazon.com/ and choosing My Account. Create a user with administrative access After you sign up for an AWS account, secure your AWS account root user, enable AWS IAM Identity Center, and create an administrative user so that you don't use the root user for everyday tasks. Sign up for an AWS account 3 AWS Supply Chain Administrator Guide Secure your AWS account root user 1. Sign in to the AWS Management Console as the account owner by choosing Root user and entering your AWS account email address. On the next page, enter your password. For help signing in by using root user, see Signing in as the root user in the AWS Sign-In User Guide. 2. Turn on multi-factor authentication (MFA) for your root user. For instructions, see Enable a virtual MFA device for your AWS account root user (console) in the IAM User Guide. Create a user with administrative access 1. Enable IAM Identity Center. For instructions, see Enabling AWS IAM Identity Center in the AWS IAM Identity Center User Guide. 2. In IAM Identity Center, grant administrative access to a user. For a tutorial about using the IAM Identity Center directory as your identity source, see Configure user access with the default IAM Identity Center directory in the AWS IAM Identity Center User Guide. Sign in as the user with administrative access • To sign in with your IAM Identity Center user, use the sign-in URL that was sent to your email address when you created the IAM Identity Center user. For help signing in using an IAM Identity Center user, see Signing in to the AWS access portal in the AWS Sign-In User Guide. Assign access to additional users 1. In IAM Identity Center, create a permission set that follows the best practice of applying least- privilege permissions. For instructions, see Create a permission set in the AWS IAM Identity Center User Guide. Create a user with administrative access 4 AWS Supply Chain Administrator Guide 2. Assign users to a group, and then assign single sign-on access to the group. For instructions, see Add groups in the AWS IAM Identity Center User Guide. Create a user with administrative access 5 AWS Supply Chain Administrator Guide Prerequisites to use AWS Supply Chain Before you create an AWS Supply Chain instance, make sure that you complete the following steps: • You have an AWS account. To create an AWS account, see Setting up an AWS account. • Make sure IAM Identity Center is enabled. To enable IAM Identity Center, see Enabling IAM Identity Center. • You have the necessary administrative permissions. For more information regarding permissions, see Advanced configuration. • An IAM Identity Center instance must be activated in the same region where you want to create your AWS Supply Chain instance. AWS Supply Chain is only supported in US East (N. Virginia), US West (Oregon), Europe (Frankfurt), Asia Pacific (Sydney), and Europe (Ireland) Region. If the AWS Supply Chain instance is not in the same region as the IAM Identity Center region, contact us for further assistance. • You must have at least have one user in the IAM Identity Center instance to assign as the AWS Supply Chain administrator. You can connect your active directory to IAM Identity Center. For more information, see Connect to a Microsoft AD directory. • Add any additional users who need access to AWS Supply Chain to IAM Identity Center. • You need AWS Key Management Service (AWS KMS) to create an instance. AWS
|
supplychain-ag-003
|
supplychain-ag.pdf
| 3 |
and Europe (Ireland) Region. If the AWS Supply Chain instance is not in the same region as the IAM Identity Center region, contact us for further assistance. • You must have at least have one user in the IAM Identity Center instance to assign as the AWS Supply Chain administrator. You can connect your active directory to IAM Identity Center. For more information, see Connect to a Microsoft AD directory. • Add any additional users who need access to AWS Supply Chain to IAM Identity Center. • You need AWS Key Management Service (AWS KMS) to create an instance. AWS Supply Chain uses this AWS KMS key to encrypt all the data that comes into AWS Supply Chain. For information about AWS KMS Keys, see Creating keys. 6 AWS Supply Chain Administrator Guide Getting started with AWS Supply Chain In this section, you can learn to create an AWS Supply Chain instance, grant user permission roles, log into the AWS Supply Chain web application, and create custom user permission roles. An AWS account can have up to 10 AWS Supply Chain instances in active or initializing state. Topics • Step 1: Assign an IAM Identity Center User profile • Step 2: Create an instance • Step 3: Choose an AWS Supply Chain application owner • Log on to AWS Supply Chain web application Step 1: Assign an IAM Identity Center User profile To create an instance and use the AWS Supply Chain service, you need to either connect an existing IAM Identity Center user profile or create a new one. 1. Open the AWS Supply Chain console. You can also search for "AWS Supply Chain" from the main AWS Management Console. 2. If necessary, change the AWS Region by selecting Select a Region located at the top of the console. Choose your Region from the drop-down list. 3. Select Create AWS Supply Chain instance. A notification will appear. Step 1: Assign an IAM Identity Center User profile 7 AWS Supply Chain Administrator Guide 4. Enter your email address and select Continue. IdC will verify if the email matches an existing user. 5. Do one of the following: • If IdC matches the email address to a user – Select Connect your identity source and onboard your team. Note This can be used if your organization has an established IdC instance that you would like to use for AWS Supply Chain. • If IdC does not find a match to an existing user – A Create a New User notification appears. Proceed to the next step. 6. In the notification, enter the following then select Continue: • Email address • First name • Last name IdC creates the user automatically and adds them as the AWS Supply Chain administrator. 7. Do one of the following: • To create an instance using standard configuration – Select Create. See the section called “Use standard configuration”. • To create an instance using a custom configuration – Select Edit in advanced setup. See the section called “Use advanced configuration”. Step 2: Create an instance Creating an instance in AWS Supply Chain establishes a dedicated environment for supply chain management and analytics. To set up an instance, you configure basic details, establish settings, and define initial user access permissions. Step 2: Create an instance 8 AWS Supply Chain Note Administrator Guide Only the AWS Management Console administrator can create an instance. The AWS Management Console administrator who creates the AWS Supply Chain instance should have all permissions listed under Using the AWS Supply Chain. This administrator should invite an IAM user as a AWS Supply Chain administrator to manage AWS Supply Chain. You create an instance using one of two methods, Standard configuration or Advanced configuration. Standard configuration uses an automated process that creates your instance quickly using preset parameters. Advanced configuration allows you to customize your instance by setting your own parameters. Topics • Use standard configuration • Use advanced configuration Use standard configuration Standard configuration creates your AWS Supply Chain instance using default security and encryption settings. Instances operate in AWS geographic regions. For more information about regions, see Regions and endpoints in the IAM User Guide and Regional endpoints in the AWS General Reference. To create an AWS Supply Chain instance using a standard configuration of preset parameters, follow these steps. 1. Select Create. Use standard configuration 9 AWS Supply Chain Administrator Guide A confirmation will appear. 2. Check your email for the following: • An email from the IdC team. • An email from Identity Management team. Use standard configuration 10 AWS Supply Chain Administrator Guide 3. Once you receive the invite email, log on to AWS Supply Chain. See the section called “Log on to AWS Supply Chain web application” . Use advanced configuration Advanced configuration allows you to customize your
|
supplychain-ag-004
|
supplychain-ag.pdf
| 4 |
Reference. To create an AWS Supply Chain instance using a standard configuration of preset parameters, follow these steps. 1. Select Create. Use standard configuration 9 AWS Supply Chain Administrator Guide A confirmation will appear. 2. Check your email for the following: • An email from the IdC team. • An email from Identity Management team. Use standard configuration 10 AWS Supply Chain Administrator Guide 3. Once you receive the invite email, log on to AWS Supply Chain. See the section called “Log on to AWS Supply Chain web application” . Use advanced configuration Advanced configuration allows you to customize your instance by setting your own parameters. To create an AWS Supply Chain instance using an advanced configuration of preset parameters, follow these steps. 1. Select Edit in advanced setup. Use advanced configuration 11 AWS Supply Chain Administrator Guide The Instance properties page will appear. Use advanced configuration 12 AWS Supply Chain Administrator Guide 2. Enter the following on the Instance properties page: • Name – Enter an instance name. • Description – Enter a description of your AWS Supply Chain instance (e.g., production instance, test instance, etc.). • AWS KMS Key (Optional) – You can either choose to use the default AWS KMS Key (recommended) or provide your own AWS KMS Key. See the section called “Using a custom AWS KMS key” for more information. • Instance tags – You can add tags to your instance that can be used for identification. For example, you can add a tag to define the type of instance you are creating (e.g., production, test, UAT, etc.). Note If you plan to use an S/4 Hana data connection, make sure that the AWS KMS key that you provided has the aws-supply-chain-access tag with an associated Value of true. Use advanced configuration 13 AWS Supply Chain Administrator Guide 3. 4. Select Create instance. (Optional) Once your AWS Supply Chain instance is created and if you chose to use your own AWS KMS Key under AWS KMS Key, update your KMS policy to allow AWS Supply Chain to access your AWS KMS key. Note Replace YourAccountNumber and YourInstanceID with your AWS account and AWS Supply Chain Instance ID. { "Sid": "Allow AWS Supply Chain to access the AWS KMS Key", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::YourAccountNumber:role/service-role/scn-instance- role-YourInstanceID" }, "Action": [ "kms:Encrypt", "kms:Decrypt", "kms:GenerateDataKey" ], "Resource": "*" } Using a custom AWS KMS key You can use your own AWS KMS key when creating instances. If you want to manage your own key, but do not wish to use an existing key you can create a new key. Note Using an AWS owned key is the recommended default setting for AWS Supply Chain instances. Use advanced configuration 14 AWS Supply Chain Administrator Guide Using an existing AWS KMS key 1. Choose Customize encryption settings. 2. Go to Choose an AWS KMS Key. 3. 4. Enter your key in the provided field. Select Update. Creating an AWS KMS key 1. 2. Select Create. Follow the steps in Create a KMS key. 3. Update the new key with the following permissions. • Define key administrative permissions: Leave unchecked • Define key usage permissions: Leave unchecked • Update key policy: Edit key policy and replace with: { "Version": "2012-10-17", "Statement": [ { "Sid": "Enable IAM User Permissions", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::YourAccountNumber:root" }, "Action": "kms:*", "Resource": "*" }, { "Sid": "Allow access through SecretManager for all principals in the account that are authorized to use SecretManager", "Effect": "Allow", "Principal": { "AWS": "*" }, "Action": [ "kms:Encrypt", "kms:Decrypt", Use advanced configuration 15 AWS Supply Chain Administrator Guide "kms:ReEncrypt*", "kms:GenerateDataKey*", "kms:CreateGrant", "kms:DescribeKey", "kms:GenerateDataKeyWithoutPlaintext", "kms:ReEncryptFrom", "kms:ReEncryptTo" ], "Resource": "*", "Condition": { "StringEquals": { "kms:ViaService": "secretsmanager.Region.amazonaws.com", "kms:CallerAccount": "YourAccountNumber" } } }, { "Sid": "Allow AWS Supply Chain to access the AWS KMS Key", "Effect": "Allow", "Principal": { "Service": "scn.Region.amazonaws.com" }, "Action": [ "kms:Encrypt", "kms:GenerateDataKeyWithoutPlaintext", "kms:ReEncryptFrom", "kms:ReEncryptTo", "kms:Decrypt", "kms:GenerateDataKey", "kms:DescribeKey", "kms:CreateGrant", "kms:RetireGrant" ], "Resource":"*" } ] } Use advanced configuration 16 AWS Supply Chain Administrator Guide Step 3: Choose an AWS Supply Chain application owner As an AWS console administrator, you choose an AWS Supply Chain application owner to manage the AWS Supply Chain web application access. The AWS Supply Chain application owner can add or remove user permission roles to the AWS Supply Chain web application. After the instance is created and an identity source is connected, follow these steps to choose an AWS Supply Chain application owner. 1. Open the AWS Supply Chain console dashboard. 2. Go to Select application owner and select a user to be an AWS Supply Chain application owner. Search results only show users matching the search criteria. 3. (Optional) Choose Go to IAM Identity Center to add more users. For more information on adding users, see Manage your identity source in AWS IAM Identity Center User Guide
|
supplychain-ag-005
|
supplychain-ag.pdf
| 5 |
add or remove user permission roles to the AWS Supply Chain web application. After the instance is created and an identity source is connected, follow these steps to choose an AWS Supply Chain application owner. 1. Open the AWS Supply Chain console dashboard. 2. Go to Select application owner and select a user to be an AWS Supply Chain application owner. Search results only show users matching the search criteria. 3. (Optional) Choose Go to IAM Identity Center to add more users. For more information on adding users, see Manage your identity source in AWS IAM Identity Center User Guide and for more information on user permission roles, see User permission roles. Step 3: Choose an AWS Supply Chain application owner 17 AWS Supply Chain Note Administrator Guide You can only add one user at a time from the AWS Supply Chain Console. You cannot add a group as an application owner in AWS Supply Chain. 4. Choose Send Invite. An email is sent to the web application administrator. Once the web application administrator receives the invite email, they will be able to select the application URL and log into the AWS Supply Chain. On the AWS Supply Chain console dashboard, you will see the user listed under Application owner. Step 3: Choose an AWS Supply Chain application owner 18 AWS Supply Chain Administrator Guide Choose Manage in AWS Supply Chain to add and remove users in the AWS Supply Chain web application Log on to AWS Supply Chain web application As an AWS Supply Chain administrator, you should have received an email invite to the AWS Supply Chain web application. 1. You can either choose the link in the email or on the AWS Supply Chain console dashboard, under Sub-domain, choose web URL. The AWS Supply Chain web application login page appears. 2. Enter the AWS IAM Identity Center user credentials and choose Sign in. Note You will only be asked to complete profiles for your account and organization when you log in for the first time. 3. On the Complete your profile page, enter your Job Title and Time zone. Choose Next. 4. On the Let's add your organization information page, enter the Organization name and choose Headquarters location. Optionally, you can add a company logo. Choose Next. 5. On the Set up your teammates on AWS Supply Chain page, select the users who you want to have access to the AWS Supply Chain web application. Choose Invite Users. For information on AWS Supply Chain user permission roles, see Managing user permission roles. 6. If you want to add users later, you can choose Skip for now. The Onboarding complete page appears. 7. Each user that you added receives an email message with a link that goes to AWS Supply Chain, or you can choose Copy link and send the link to the users. 8. Choose Continue to homepage to view the AWS Supply Chain dashboard. Log on to AWS Supply Chain web application 19 AWS Supply Chain Administrator Guide Using the AWS Supply Chain AWS Supply Chain is a cloud-based application that helps you gain visibility into your supply chain network, make informed decisions quickly, and improve supply chain resiliency. Using AWS Supply Chain, you can connect disparate data sources, generate insights using machine learning, and collaborate with internal teams and external partners. This section will walk you through some of AWS Supply Chain basic functions. Topics • Using AWS Supply Chain console • Updating your profile • Managing user permission roles • Deleting an instance Using AWS Supply Chain console Using the console is the easiest way to manage your service resources and configurations. The console provides an intuitive web-based interface where you can view, create, modify, and monitor your resources. This section shows you how to access and navigate the console to perform common management tasks. Note If your AWS account is a member account of an AWS organization and includes a Service Control Policy (SCP), make sure the organization's SCP grants the following permissions to the member account. If the following permissions are not included in the organization's SCP policy, AWS Supply Chain instance creation will fail. To access the AWS Supply Chain console, you must have a minimum set of permissions. These permissions must allow you to list and view details about the AWS Supply Chain resources in your AWS account. If you create an identity-based policy that is more restrictive than the minimum required permissions, the console won't function as intended for entities (users or roles) with that policy. Using AWS Supply Chain console 20 AWS Supply Chain Administrator Guide You don't need to allow minimum console permissions for users that are making calls only to the AWS CLI or the AWS API. Instead, allow access to only the actions that match
|
supplychain-ag-006
|
supplychain-ag.pdf
| 6 |
you must have a minimum set of permissions. These permissions must allow you to list and view details about the AWS Supply Chain resources in your AWS account. If you create an identity-based policy that is more restrictive than the minimum required permissions, the console won't function as intended for entities (users or roles) with that policy. Using AWS Supply Chain console 20 AWS Supply Chain Administrator Guide You don't need to allow minimum console permissions for users that are making calls only to the AWS CLI or the AWS API. Instead, allow access to only the actions that match the API operation that they're trying to perform. The following permissions are needed by the Console Admin to create and update AWS Supply Chain instances successfully. { "Version": "2012-10-17", "Statement": [ { "Action": "scn:*", "Resource": "*", "Effect": "Allow" }, { "Action": [ "s3:GetObject", "s3:PutObject", "s3:ListBucket", "s3:CreateBucket", "s3:PutBucketVersioning", "s3:PutBucketObjectLockConfiguration", "s3:PutEncryptionConfiguration", "s3:PutBucketPolicy", "s3:PutLifecycleConfiguration", "s3:PutBucketPublicAccessBlock", "s3:DeleteObject", "s3:ListAllMyBuckets", "s3:PutBucketOwnershipControls", "s3:PutBucketNotification", "s3:PutAccountPublicAccessBlock", "s3:PutBucketLogging", "s3:PutBucketTagging" ], "Resource": "arn:aws:s3:::aws-supply-chain-*", "Effect": "Allow" }, { "Action": [ "cloudtrail:CreateTrail", "cloudtrail:PutEventSelectors", "cloudtrail:GetEventSelectors", Using AWS Supply Chain console 21 AWS Supply Chain Administrator Guide "cloudtrail:StartLogging" ], "Resource": "*", "Effect": "Allow" }, { "Action": [ "events:DescribeRule", "events:PutRule", "events:PutTargets" ], "Resource": "*", "Effect": "Allow" }, { "Action": [ "chime:CreateAppInstance", "chime:DeleteAppInstance", "chime:PutAppInstanceRetentionSettings", "chime:TagResource" ], "Resource": "*", "Effect": "Allow" }, { "Action": [ "cloudwatch:PutMetricData", "cloudwatch:Describe*", "cloudwatch:Get*", "cloudwatch:List*" ], "Resource": "*", "Effect": "Allow" }, { "Action": [ "organizations:CreateOrganization", "organizations:DescribeAccount", "organizations:DescribeOrganization", "organizations:EnableAWSServiceAccess", "organizations:ListDelegatedAdministrators" ], "Resource": "*", "Effect": "Allow" Using AWS Supply Chain console 22 Administrator Guide AWS Supply Chain }, { "Action": [ "kms:CreateGrant", "kms:RetireGrant", "kms:DescribeKey" ], "Resource": key_arn, "Effect": "Allow" }, { "Action": [ "kms:ListAliases" ], "Resource": "*", "Effect": "Allow" }, { "Action": [ "iam:CreateRole", "iam:CreatePolicy", "iam:GetRole", "iam:PutRolePolicy", "iam:AttachRolePolicy", "iam:CreateServiceLinkedRole" ], "Resource": "*", "Effect": "Allow" }, { "Action": [ "sso:AssociateDirectory", "sso:AssociateProfile", "sso:CreateApplication", "sso:CreateApplicationAssignment", "sso:CreateInstance", "sso:CreateManagedApplicationInstance", "sso:DeleteApplication", "sso:DeleteApplicationAssignment", "sso:DeleteManagedApplicationInstance", "sso:DescribeApplication", "sso:DescribeDirectories", "sso:DescribeInstance", "sso:DescribeRegisteredRegions", Using AWS Supply Chain console 23 AWS Supply Chain Administrator Guide "sso:DescribeTrusts", "sso:DisassociateProfile", "sso:GetManagedApplicationInstance", "sso:GetPeregrineStatus", "sso:GetProfile", "sso:GetSharedSsoConfiguration", "sso:GetSsoConfiguration", "sso:GetSSOStatus", "sso:ListApplicationAssignments", "sso:ListApplicationTemplates", "sso:ListDirectoryAssociations", "sso:ListInstances", "sso:ListProfileAssociations", "sso:ListProfiles", "sso:PutApplicationAuthenticationMethod", "sso:PutApplicationGrant", "sso:RegisterRegion", "sso:SearchDirectoryGroups", "sso:SearchDirectoryUsers", "sso:SearchGroups", "sso:SearchUsers", "sso:StartPeregrine", "sso:StartSSO", "sso:UpdateSsoConfiguration", "sso-directory:SearchUsers" ], "Resource": "*", "Effect": "Allow" } ] } key_arn specifies the key you would like to use for the AWS Supply Chain instance. For best practices and to restrict access to only the keys you would like to use for AWS Supply Chain, see Specifying KMS keys in IAM policy statements. To represent all KMS keys, use a wildcard character alone ("*"). Updating your profile You can update your account and organization profile anytime on the AWS Supply Chain web application. Updating your profile 24 AWS Supply Chain Administrator Guide Updating your account profile To update your account profile, follow these steps. 1. On the AWS Supply Chain web application dashboard, from the left navigation pane, choose the Settings icon. 2. Choose Account Profile. The Account Profile page appears. 3. Update the account information, and choose Save. Updating your organization profile To update the organization profile, follow these steps. 1. On the AWS Supply Chain web application dashboard, from the left navigation pane, choose the Settings icon. 2. Choose Organization, and then choose Organization Profile. The Organization Profile page appears. 3. Update the organization Logo or Headquarters location, and then choose Save. Managing user permission roles As an AWS Supply Chain administrator, you can either use the default user permission roles or create custom permission roles. AWS Supply Chain has the following default user permission roles: • Administrator – Access to create, view, and manage all data and user permissions. • Data Analyst – Access to create, view, and manage all data connections. • Inventory Manager – Access to create, view, and manage Insights. • Demand Planner – Access to create, view and manage forecasts, overrides, and publish demand plans. • Partner Data Manager – Access to manage and view partners, manage and view data requests, and view sustainability data. • Supply Planner – Access to manage and view supply plans. Updating your account profile 25 AWS Supply Chain Note Administrator Guide As an AWS Supply Chain administrator, before you add users, note the following: • Each default user permission role is defined with a set of permissions. You can add users to default user permission roles or create custom permission roles. • A user can only be assigned to one user permission role. • You cannot edit or delete default user permission roles. • When you edit a custom permission role you created, the permissions for all the users under the custom permission role are updated. • When you delete a custom permission role you created, all the users under the custom permission role will lose access to AWS Supply Chain. • Adding groups is not supported in AWS Supply Chain. Topics • Adding users • Updating user permissions • Deleting users • Creating custom user permission roles
|
supplychain-ag-007
|
supplychain-ag.pdf
| 7 |
custom permission roles. • A user can only be assigned to one user permission role. • You cannot edit or delete default user permission roles. • When you edit a custom permission role you created, the permissions for all the users under the custom permission role are updated. • When you delete a custom permission role you created, all the users under the custom permission role will lose access to AWS Supply Chain. • Adding groups is not supported in AWS Supply Chain. Topics • Adding users • Updating user permissions • Deleting users • Creating custom user permission roles Adding users As an AWS Supply Chain administrator, you can add users to access the AWS Supply Chain web application. Users first must be added to IAM Identity Center (IdC), and then they can be added to AWS Supply Chain. For more information about adding users to IdC, see Assign user access. Once users have been added to IdC, follow these steps to add an user. 1. Choose the Settings icon on the AWS Supply Chain dashboard. 2. 3. 4. 5. Select Users and Permissions. Select Users, Users. The Manage Users page appears. Select Add New User. The Add User page appears. Select the user from the Add user(s) drop-down menu. Adding users 26 AWS Supply Chain Administrator Guide 6. 7. Select the role for the user from the under Select role drop-down menu. Select Add. Updating user permissions To update the user permission role for the current AWS Supply Chain users, follow these steps. 1. On the AWS Supply Chain dashboard, from the left navigation pane, choose the Settings icon. 2. Choose Permissions, and then choose Users. The Manage Users page appears. 3. On the Manage Users page, select the user or group that you want to update the user permission role for, and from the Permissions Role dropdown menu, select one of the permission roles. Note Depending on the role permissions you assign, the AWS Supply Chain dashboard is customized. For more information, see Creating custom user permission roles. 4. Choose Save. Deleting users As an AWS Supply Chain administrator, you can delete users from the AWS Supply Chain web application. Follow these steps to delete users. 1. On the AWS Supply Chain dashboard, from the left navigation pane, choose the Settings icon. 2. Choose Permissions, and then choose Users. The Manage Users page appears. 3. On the Manage Users page, select the user that you want to delete and choose the Delete icon. Updating user permissions 27 AWS Supply Chain Administrator Guide Creating custom user permission roles In addition to default user permission roles, you can create custom user permission roles to include multiple permission roles and add specific locations and products. Follow these steps to create new permission roles. 1. On the AWS Supply Chain dashboard, from the left navigation pane, choose the Settings icon. Choose Permissions, and then choose Permission Roles. The Permission Roles page appears. 2. Choose Create New Role. 3. On the Manage Permission Role page, under Role Name, enter a name. 4. Move the slider to select the user permission role. • Manage – Assigning users with manage permission can add, edit, and manage information. • View – Assigning users with view permission can only view the current information. 5. Note You can only choose the products and locations under Location Access and Product Access if your instance is connected to a data source. For example, you can create a custom Admin user just to manage avocados in the Seattle location, or an Insight user just to manage the insights for avocados in the Seattle location. Under Location Access, search for the Regions as you type in the search bar and select the Regions. 6. Under Product Access, search for the products as you type in the search bar and select the products. 7. Choose Save. Deleting an instance To delete an instance, follow these steps. Creating custom user permission roles 28 AWS Supply Chain Note Administrator Guide When you delete an instance, information from the Amazon S3 bucket is not automatically deleted. 1. Open the AWS Supply Chain console at https://console.aws.amazon.com/scn/home. 2. On the AWS Supply Chain console dashboard, from the dropdown, select the instance that you want to delete. 3. Choose Delete. 4. On the Delete AWS Supply Chain Instance page, under Confirmation, type delete to confirm that you want to delete the instance. 5. Choose Delete. The instance deletion starts and once the instance is deleted, you will see a confirmation message. Note After the instance is deleted, information related to Amazon Q in AWS Supply Chain is automatically deleted. Deleting an instance 29 AWS Supply Chain Administrator Guide Security in AWS Supply Chain Cloud security at AWS is the highest priority. As an AWS customer, you benefit from
|
supplychain-ag-008
|
supplychain-ag.pdf
| 8 |
dropdown, select the instance that you want to delete. 3. Choose Delete. 4. On the Delete AWS Supply Chain Instance page, under Confirmation, type delete to confirm that you want to delete the instance. 5. Choose Delete. The instance deletion starts and once the instance is deleted, you will see a confirmation message. Note After the instance is deleted, information related to Amazon Q in AWS Supply Chain is automatically deleted. Deleting an instance 29 AWS Supply Chain Administrator Guide Security in AWS Supply Chain Cloud security at AWS is the highest priority. As an AWS customer, you benefit from data centers and network architectures that are AWS builds to meet the requirements of the most security- sensitive organizations. Security is a shared responsibility between you and AWS. The shared responsibility model describes this as security of the cloud and security in the cloud: • Security of the cloud – AWS is responsible for protecting the infrastructure that runs AWS services in the AWS Cloud. AWS also provides you with services that you can use securely. Third- party auditors regularly test and verify the effectiveness of our security as part of the AWS Compliance Programs. To learn about the compliance programs that apply to AWS Supply Chain, see AWS Services in Scope by Compliance Program. • Security in the cloud – The AWS service that you use determines your responsibility. You are also responsible for other factors. include the sensitivity of your data, your requirements, and applicable laws and regulations. This documentation helps you understand how to apply the shared responsibility model when you use AWS Supply Chain. The following topics show you how to configure AWS Supply Chain to meet your security and compliance objectives. You also learn how to use other AWS services that help you to monitor and secure your AWS Supply Chain resources. Topics • Data protection in AWS Supply Chain • Access AWS Supply Chain using an interface endpoint (AWS PrivateLink) • IAM for AWS Supply Chain • AWS managed policies for AWS Supply Chain • Compliance validation for AWS Supply Chain • Resilience in AWS Supply Chain • Logging and Monitoring AWS Supply Chain • Managing AWS Supply Chain events using Amazon EventBridge 30 AWS Supply Chain Administrator Guide Data protection in AWS Supply Chain The AWS shared responsibility model applies to data protection in AWS Supply Chain. As described in this model, AWS is responsible for protecting the global infrastructure that runs all of the AWS Cloud. You are responsible for maintaining control over your content that is hosted on this infrastructure. You are also responsible for the security configuration and management tasks for the AWS services that you use. For more information about data privacy, see the Data Privacy FAQ. For information about data protection in Europe, see the AWS Shared Responsibility Model and GDPR blog post on the AWS Security Blog. For data protection purposes, we recommend that you protect AWS account credentials and set up individual users with AWS IAM Identity Center or AWS Identity and Access Management (IAM). That way, each user is given only the permissions necessary to fulfill their job duties. We also recommend that you secure your data in the following ways: • Use multi-factor authentication (MFA) with each account. • Use SSL/TLS to communicate with AWS resources. We require TLS 1.2 and recommend TLS 1.3. • Set up API and user activity logging with AWS CloudTrail. For information about using CloudTrail trails to capture AWS activities, see Working with CloudTrail trails in the AWS CloudTrail User Guide. • Use AWS encryption solutions, along with all default security controls within AWS services. • Use advanced managed security services such as Amazon Macie, which assists in discovering and securing sensitive data that is stored in Amazon S3. • If you require FIPS 140-3 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS endpoint. For more information about the available FIPS endpoints, see Federal Information Processing Standard (FIPS) 140-3. We strongly recommend that you never put confidential or sensitive information, such as your customers' email addresses, into tags or free-form text fields such as a Name field. This includes when you work with AWS Supply Chain or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter into tags or free-form text fields used for names may be used for billing or diagnostic logs. If you provide a URL to an external server, we strongly recommend that you do not include credentials information in the URL to validate your request to that server. Data protection 31 AWS Supply Chain Administrator Guide Data handled by AWS Supply Chain To limit the data that can be accessed by authorized users of a specific AWS Supply
|
supplychain-ag-009
|
supplychain-ag.pdf
| 9 |
you work with AWS Supply Chain or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter into tags or free-form text fields used for names may be used for billing or diagnostic logs. If you provide a URL to an external server, we strongly recommend that you do not include credentials information in the URL to validate your request to that server. Data protection 31 AWS Supply Chain Administrator Guide Data handled by AWS Supply Chain To limit the data that can be accessed by authorized users of a specific AWS Supply Chain instance, data held within AWS Supply Chain is segregated by your AWS account ID and your AWS Supply Chain instance ID. AWS Supply Chain handles a variety of supply chain data such as, user information, information extracted from the data connector, and inventory details. Opt-out preference We may use and store Your Content that is processed by AWS Supply Chain, as noted in the AWS Service Terms. If you want to opt-out from AWS Supply Chain to use or store your content, you can create an opt-out policy in AWS Organizations. For more information on creating an opt-out policy, see AI services opt-out policy syntax and examples . Encryption at rest Contact data classified as PII, or data that represents customer content including content used in Amazon Q in AWS Supply Chain being stored by AWS Supply Chain, is encrypted at rest (that is, before it is put, stored, or saved to a disk) with a key that is time-limited and specific to the AWS Supply Chain instance. Amazon S3 server-side encryption is used to encrypt all console and web application data with a AWS Key Management Service data key that is unique to each customer account. For information about AWS KMS keys, see What is AWS Key Management Service? in the AWS Key Management Service Developer Guide. Note AWS Supply Chain features Supply Planning and N-Tier Visibility does not support encrypting data-at-rest with the provided KMS-CMK. Encryption in transit Data including content used in Amazon Q in AWS Supply Chain exchanged with AWS Supply Chain is protected in transit between the user’s web browser and AWS Supply Chain using industry- standard TLS encryption. Data handled by AWS Supply Chain 32 AWS Supply Chain Key management AWS Supply Chain partially supports KMS-CMK. Administrator Guide For information on updating the AWS KMS key in AWS Supply Chain, see Step 2: Create an instance. Inter-network traffic privacy Note AWS Supply Chain does not support PrivateLink. A virtual private cloud (VPC) endpoint for AWS Supply Chain is a logical entity within a VPC that allows connectivity only to AWS Supply Chain. The VPC routes requests to AWS Supply Chain and routes responses back to the VPC. For more information, see VPC Endpoints in the VPC User Guide. How AWS Supply Chain uses grants in AWS KMS AWS Supply Chain requires a grant to use your customer managed key. AWS Supply Chain creates several grants using the AWS KMS key that is passed during the CreateInstance operation. AWS Supply Chain creates a grant on your behalf by sending CreateGrant requests to AWS KMS. Grants in AWS KMS are used to give AWS Supply Chain access to the AWS KMS key in a customer account. Note AWS Supply Chain uses it's own authorization mechanism. Once an user is added to AWS Supply Chain, you cannot deny list the same user using the AWS KMS policy. AWS Supply Chain uses the grant for the following: • To send GenerateDataKey requests to AWS KMS to encrypt the data stored in your instance. • To send Decrypt requests to AWS KMS in order to read your encrypted data associated with the instance. Key management 33 AWS Supply Chain Administrator Guide • To add DescribeKey, CreateGrant, and RetireGrant permissions in order to keep your data secured when sending it to other AWS services like Amazon Forecast. You can revoke access to the grant, or remove the service's access to the customer managed key at any time. If you do, AWS Supply Chain won't be able to access any of the data encrypted by the customer managed key, which affects operations that are dependent on that data. Monitoring your encryption for AWS Supply Chain The following examples are AWS CloudTrail events for Encrypt, GenerateDataKey, and Decrypt to monitor KMS operations called by AWS Supply Chain to access data encrypted by your customer managed key: Encrypt { "eventVersion": "1.08", "userIdentity": { "type": "AWSService", "invokedBy": "scn.amazonaws.com" }, "eventTime": "2024-03-06T22:39:32Z", "eventSource": "kms.amazonaws.com", "eventName": "Encrypt", "awsRegion": "us-east-1", "sourceIPAddress": "172.12.34.56" "userAgent": "Example/Desktop/1.0 (V1; OS)", "requestParameters": { "encryptionAlgorithm": "SYMMETRIC_DEFAULT", "keyId": "arn:aws:kms:us- east-1:123456789:key/1234abcd-11ab-22bc-33ef-123456sample" }, "responseElements": null, "requestID": "12a345n4-78a4-8888-0000-a000-6q000yy666rr", "eventID": "12a345n4-78a4-8888-0000-a000-6q000yy666rr", "readOnly": true, "resources": [ { "accountId": account ID, "type": "AWS::KMS::Key", How AWS Supply Chain uses grants
|
supplychain-ag-010
|
supplychain-ag.pdf
| 10 |
affects operations that are dependent on that data. Monitoring your encryption for AWS Supply Chain The following examples are AWS CloudTrail events for Encrypt, GenerateDataKey, and Decrypt to monitor KMS operations called by AWS Supply Chain to access data encrypted by your customer managed key: Encrypt { "eventVersion": "1.08", "userIdentity": { "type": "AWSService", "invokedBy": "scn.amazonaws.com" }, "eventTime": "2024-03-06T22:39:32Z", "eventSource": "kms.amazonaws.com", "eventName": "Encrypt", "awsRegion": "us-east-1", "sourceIPAddress": "172.12.34.56" "userAgent": "Example/Desktop/1.0 (V1; OS)", "requestParameters": { "encryptionAlgorithm": "SYMMETRIC_DEFAULT", "keyId": "arn:aws:kms:us- east-1:123456789:key/1234abcd-11ab-22bc-33ef-123456sample" }, "responseElements": null, "requestID": "12a345n4-78a4-8888-0000-a000-6q000yy666rr", "eventID": "12a345n4-78a4-8888-0000-a000-6q000yy666rr", "readOnly": true, "resources": [ { "accountId": account ID, "type": "AWS::KMS::Key", How AWS Supply Chain uses grants in AWS KMS 34 AWS Supply Chain Administrator Guide "ARN": "arn:aws:kms:us- east-1:123456789:key/1234abcd-11ab-22bc-33ef-123456sample" } ], "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "112233445566", "sharedEventID": "fdf9ee0f-e43f-4e43-beac-df69067edb8b", "eventCategory": "Management" } GenerateDataKey { "eventVersion": "1.08", "userIdentity": { "type": "AWSService", "invokedBy": "scn.amazonaws.com" }, "eventTime": "2024-03-06T22:39:32Z", "eventSource": "kms.amazonaws.com", "eventName": "GenerateDataKey", "awsRegion": "us-east-1", "sourceIPAddress": "172.12.34.56" "userAgent": "Example/Desktop/1.0 (V1; OS)", "requestParameters": { "encryptionContext": { "aws:s3:arn": "arn:aws:s3:::test/rawEvent/bf6666c1-111-48aaca-b6b0- dsadsadsa3432423/noFlowName/scn.data.inboundorder/20240306_223934_536" }, "keyId": "arn:aws:kms:us- east-1:123456789:key/1234abcd-11ab-22bc-33ef-123456sample", "keySpec": "AES_222" }, "responseElements": null, "requestID": "12a345n4-78a4-8888-0000-a000-6q000yy666rr", "eventID": "12a345n4-78a4-8888-0000-a000-6q000yy666rr", "readOnly": true, "resources": [ { "accountId": account ID, How AWS Supply Chain uses grants in AWS KMS 35 AWS Supply Chain Administrator Guide "type": "AWS::KMS::Key", "ARN": "arn:aws:kms:us- east-1:123456789:key/1234abcd-11ab-22bc-33ef-123456sample" } ], "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "112233445566", "sharedEventID": "fdf9ee0f-e43f-4e43-beac-df69067edb8b", "eventCategory": "Management" } Decrypt { "eventVersion": "1.08", "userIdentity": { "type": "AWSService", "invokedBy": "scn.amazonaws.com" }, "eventTime": "2024-03-06T22:39:32Z", "eventSource": "kms.amazonaws.com", "eventName": "Decrypt", "awsRegion": "us-east-1", "sourceIPAddress": "172.12.34.56" "userAgent": "Example/Desktop/1.0 (V1; OS)", "requestParameters": { "keyId": "arn:aws:kms:us- east-1:123456789:key/1234abcd-11ab-22bc-33ef-123456sample", "encryptionAlgorithm": "SYMMETRIC_DEFAULT" }, "responseElements": null, "requestID": "12a345n4-78a4-8888-0000-a000-6q000yy666rr", "eventID": "12a345n4-78a4-8888-0000-a000-6q000yy666rr", "readOnly": true, "resources": [ { "accountId": account ID, "type": "AWS::KMS::Key", "ARN": "arn:aws:kms:us- east-1:123456789:key/1234abcd-11ab-22bc-33ef-123456sample" How AWS Supply Chain uses grants in AWS KMS 36 AWS Supply Chain } Administrator Guide ], "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "112233445566", "sharedEventID": "fdf9ee0f-e43f-4e43-beac-df69067edb8b", "eventCategory": "Management" } Access AWS Supply Chain using an interface endpoint (AWS PrivateLink) You can use AWS PrivateLink to create a private connection between your VPC and AWS Supply Chain. You can access AWS Supply Chain as if it were in your VPC, without the use of an internet gateway, NAT device, VPN connection, or AWS Direct Connect connection. Instances in your VPC don't need public IP addresses to access AWS Supply Chain. You establish this private connection by creating an interface endpoint, powered by AWS PrivateLink. We create an endpoint network interface in each subnet that you enable for the interface endpoint. These are requester-managed network interfaces that serve as the entry point for traffic destined for AWS Supply Chain. For more information, see Access AWS services through AWS PrivateLink in the AWS PrivateLink Guide. Considerations for AWS Supply Chain Before you set up an interface endpoint for AWS Supply Chain, review Considerations in the AWS PrivateLink Guide. AWS Supply Chain supports making calls to all of its API actions through the interface endpoint. Create an interface endpoint for AWS Supply Chain You can create an interface endpoint for AWS Supply Chain using either the Amazon VPC console or the AWS Command Line Interface (AWS CLI). For more information, see Create an interface endpoint in the AWS PrivateLink Guide. AWS PrivateLink 37 AWS Supply Chain Administrator Guide Create an interface endpoint for AWS Supply Chain using the following service name: com.amazonaws.region.scn If you enable private DNS for the interface endpoint, you can make API requests to AWS Supply Chain using its default Regional DNS name. For example, scn.region.amazonaws.com. Create an endpoint policy for your interface endpoint An endpoint policy is an IAM resource that you can attach to an interface endpoint. The default endpoint policy allows full access to AWS Supply Chain through the interface endpoint. To control the access allowed to AWS Supply Chain from your VPC, attach a custom endpoint policy to the interface endpoint. An endpoint policy specifies the following information: • The principals that can perform actions (AWS accounts, IAM users, and IAM roles) • The actions that can be performed • The resources on which the actions can be performed For more information, see Control access to services using endpoint policies in the AWS PrivateLink Guide. Example: VPC endpoint policy for AWS Supply Chain actions The following is an example of a custom endpoint policy. When you attach this policy to your interface endpoint, it grants access to the listed AWS Supply Chain actions for all principals on all resources. { "Statement": [ { "Principal": "*", "Effect": "Allow", "Action": [ "scn:action-1", "scn:action-2", "scn:action-3" Create an endpoint policy 38 AWS Supply Chain ], "Resource":"*" } ] } IAM for AWS Supply Chain Administrator Guide AWS Identity and Access Management (IAM) is an AWS service that helps an administrator securely control access to AWS resources. IAM administrators control who can be authenticated (signed in) and authorized (have permissions) to use AWS Supply Chain resources. IAM is an AWS service that you can use with no additional charge. Topics
|
supplychain-ag-011
|
supplychain-ag.pdf
| 11 |
access to the listed AWS Supply Chain actions for all principals on all resources. { "Statement": [ { "Principal": "*", "Effect": "Allow", "Action": [ "scn:action-1", "scn:action-2", "scn:action-3" Create an endpoint policy 38 AWS Supply Chain ], "Resource":"*" } ] } IAM for AWS Supply Chain Administrator Guide AWS Identity and Access Management (IAM) is an AWS service that helps an administrator securely control access to AWS resources. IAM administrators control who can be authenticated (signed in) and authorized (have permissions) to use AWS Supply Chain resources. IAM is an AWS service that you can use with no additional charge. Topics • Audience • Authenticating with identities • Managing access using policies • How AWS Supply Chain works with IAM • Identity-based policy examples for AWS Supply Chain • Troubleshooting AWS Supply Chain identity and access Audience How you use AWS Identity and Access Management (IAM) differs, depending on the work that you do in AWS Supply Chain. Service user – If you use the AWS Supply Chain service to do your job, then your administrator provides you with the credentials and permissions that you need. As you use more AWS Supply Chain features to do your work, you might need additional permissions. Understanding how access is managed can help you request the right permissions from your administrator. If you cannot access a feature in AWS Supply Chain, see Troubleshooting AWS Supply Chain identity and access. Service administrator – If you're in charge of AWS Supply Chain resources at your company, you probably have full access to AWS Supply Chain. It's your job to determine which AWS Supply Chain features and resources your service users should access. You must then submit requests to your IAM administrator to change the permissions of your service users. Review the information on this page IAM 39 AWS Supply Chain Administrator Guide to understand the basic concepts of IAM. To learn more about how your company can use IAM with AWS Supply Chain, see How AWS Supply Chain works with IAM. IAM administrator – If you're an IAM administrator, you might want to learn details about how you can write policies to manage access to AWS Supply Chain. To view example AWS Supply Chain identity-based policies that you can use in IAM, see Identity-based policy examples for AWS Supply Chain. Authenticating with identities Authentication is how you sign in to AWS using your identity credentials. You must be authenticated (signed in to AWS) as the AWS account root user, as an IAM user, or by assuming an IAM role. You can sign in to AWS as a federated identity by using credentials provided through an identity source. AWS IAM Identity Center (IAM Identity Center) users, your company's single sign-on authentication, and your Google or Facebook credentials are examples of federated identities. When you sign in as a federated identity, your administrator previously set up identity federation using IAM roles. When you access AWS by using federation, you are indirectly assuming a role. Depending on the type of user you are, you can sign in to the AWS Management Console or the AWS access portal. For more information about signing in to AWS, see How to sign in to your AWS account in the AWS Sign-In User Guide. If you access AWS programmatically, AWS provides a software development kit (SDK) and a command line interface (CLI) to cryptographically sign your requests by using your credentials. If you don't use AWS tools, you must sign requests yourself. For more information about using the recommended method to sign requests yourself, see AWS Signature Version 4 for API requests in the IAM User Guide. Regardless of the authentication method that you use, you might be required to provide additional security information. For example, AWS recommends that you use multi-factor authentication (MFA) to increase the security of your account. To learn more, see Multi-factor authentication in the AWS IAM Identity Center User Guide and AWS Multi-factor authentication in IAM in the IAM User Guide. AWS account root user When you create an AWS account, you begin with one sign-in identity that has complete access to all AWS services and resources in the account. This identity is called the AWS account root user and Authenticating with identities 40 AWS Supply Chain Administrator Guide is accessed by signing in with the email address and password that you used to create the account. We strongly recommend that you don't use the root user for your everyday tasks. Safeguard your root user credentials and use them to perform the tasks that only the root user can perform. For the complete list of tasks that require you to sign in as the root user, see Tasks that require root user credentials in the IAM User Guide. Federated identity As a best practice, require human users, including
|
supplychain-ag-012
|
supplychain-ag.pdf
| 12 |
user and Authenticating with identities 40 AWS Supply Chain Administrator Guide is accessed by signing in with the email address and password that you used to create the account. We strongly recommend that you don't use the root user for your everyday tasks. Safeguard your root user credentials and use them to perform the tasks that only the root user can perform. For the complete list of tasks that require you to sign in as the root user, see Tasks that require root user credentials in the IAM User Guide. Federated identity As a best practice, require human users, including users that require administrator access, to use federation with an identity provider to access AWS services by using temporary credentials. A federated identity is a user from your enterprise user directory, a web identity provider, the AWS Directory Service, the Identity Center directory, or any user that accesses AWS services by using credentials provided through an identity source. When federated identities access AWS accounts, they assume roles, and the roles provide temporary credentials. For centralized access management, we recommend that you use AWS IAM Identity Center. You can create users and groups in IAM Identity Center, or you can connect and synchronize to a set of users and groups in your own identity source for use across all your AWS accounts and applications. For information about IAM Identity Center, see What is IAM Identity Center? in the AWS IAM Identity Center User Guide. IAM users and groups An IAM user is an identity within your AWS account that has specific permissions for a single person or application. Where possible, we recommend relying on temporary credentials instead of creating IAM users who have long-term credentials such as passwords and access keys. However, if you have specific use cases that require long-term credentials with IAM users, we recommend that you rotate access keys. For more information, see Rotate access keys regularly for use cases that require long- term credentials in the IAM User Guide. An IAM group is an identity that specifies a collection of IAM users. You can't sign in as a group. You can use groups to specify permissions for multiple users at a time. Groups make permissions easier to manage for large sets of users. For example, you could have a group named IAMAdmins and give that group permissions to administer IAM resources. Users are different from roles. A user is uniquely associated with one person or application, but a role is intended to be assumable by anyone who needs it. Users have permanent long-term credentials, but roles provide temporary credentials. To learn more, see Use cases for IAM users in the IAM User Guide. Authenticating with identities 41 AWS Supply Chain IAM roles Administrator Guide An IAM role is an identity within your AWS account that has specific permissions. It is similar to an IAM user, but is not associated with a specific person. To temporarily assume an IAM role in the AWS Management Console, you can switch from a user to an IAM role (console). You can assume a role by calling an AWS CLI or AWS API operation or by using a custom URL. For more information about methods for using roles, see Methods to assume a role in the IAM User Guide. IAM roles with temporary credentials are useful in the following situations: • Federated user access – To assign permissions to a federated identity, you create a role and define permissions for the role. When a federated identity authenticates, the identity is associated with the role and is granted the permissions that are defined by the role. For information about roles for federation, see Create a role for a third-party identity provider (federation) in the IAM User Guide. If you use IAM Identity Center, you configure a permission set. To control what your identities can access after they authenticate, IAM Identity Center correlates the permission set to a role in IAM. For information about permissions sets, see Permission sets in the AWS IAM Identity Center User Guide. • Temporary IAM user permissions – An IAM user or role can assume an IAM role to temporarily take on different permissions for a specific task. • Cross-account access – You can use an IAM role to allow someone (a trusted principal) in a different account to access resources in your account. Roles are the primary way to grant cross- account access. However, with some AWS services, you can attach a policy directly to a resource (instead of using a role as a proxy). To learn the difference between roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. • Cross-service access – Some AWS services use features in other AWS services. For example, when you make a
|
supplychain-ag-013
|
supplychain-ag.pdf
| 13 |
Cross-account access – You can use an IAM role to allow someone (a trusted principal) in a different account to access resources in your account. Roles are the primary way to grant cross- account access. However, with some AWS services, you can attach a policy directly to a resource (instead of using a role as a proxy). To learn the difference between roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. • Cross-service access – Some AWS services use features in other AWS services. For example, when you make a call in a service, it's common for that service to run applications in Amazon EC2 or store objects in Amazon S3. A service might do this using the calling principal's permissions, using a service role, or using a service-linked role. • Forward access sessions (FAS) – When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a different service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. Authenticating with identities 42 AWS Supply Chain Administrator Guide • Service role – A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. • Service-linked role – A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. • Applications running on Amazon EC2 – You can use an IAM role to manage temporary credentials for applications that are running on an EC2 instance and making AWS CLI or AWS API requests. This is preferable to storing access keys within the EC2 instance. To assign an AWS role to an EC2 instance and make it available to all of its applications, you create an instance profile that is attached to the instance. An instance profile contains the role and enables programs that are running on the EC2 instance to get temporary credentials. For more information, see Use an IAM role to grant permissions to applications running on Amazon EC2 instances in the IAM User Guide. Managing access using policies You control access in AWS by creating policies and attaching them to AWS identities or resources. A policy is an object in AWS that, when associated with an identity or resource, defines their permissions. AWS evaluates these policies when a principal (user, root user, or role session) makes a request. Permissions in the policies determine whether the request is allowed or denied. Most policies are stored in AWS as JSON documents. For more information about the structure and contents of JSON policy documents, see Overview of JSON policies in the IAM User Guide. Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. By default, users and roles have no permissions. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. IAM policies define permissions for an action regardless of the method that you use to perform the operation. For example, suppose that you have a policy that allows the iam:GetRole action. A user with that policy can get role information from the AWS Management Console, the AWS CLI, or the AWS API. Managing access using policies 43 AWS Supply Chain Identity-based policies Administrator Guide Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. Identity-based policies can be further categorized as inline policies or managed policies. Inline policies are embedded
|
supplychain-ag-014
|
supplychain-ag.pdf
| 14 |
Management Console, the AWS CLI, or the AWS API. Managing access using policies 43 AWS Supply Chain Identity-based policies Administrator Guide Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. Identity-based policies can be further categorized as inline policies or managed policies. Inline policies are embedded directly into a single user, group, or role. Managed policies are standalone policies that you can attach to multiple users, groups, and roles in your AWS account. Managed policies include AWS managed policies and customer managed policies. To learn how to choose between a managed policy or an inline policy, see Choose between managed policies and inline policies in the IAM User Guide. Resource-based policies Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a specific resource. For the resource where the policy is attached, the policy defines what actions a specified principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. Resource-based policies are inline policies that are located in that service. You can't use AWS managed policies from IAM in a resource-based policy. Access control lists (ACLs) Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. Amazon S3, AWS WAF, and Amazon VPC are examples of services that support ACLs. To learn more about ACLs, see Access control list (ACL) overview in the Amazon Simple Storage Service Developer Guide. Managing access using policies 44 AWS Supply Chain Other policy types Administrator Guide AWS supports additional, less-common policy types. These policy types can set the maximum permissions granted to you by the more common policy types. • Permissions boundaries – A permissions boundary is an advanced feature in which you set the maximum permissions that an identity-based policy can grant to an IAM entity (IAM user or role). You can set a permissions boundary for an entity. The resulting permissions are the intersection of an entity's identity-based policies and its permissions boundaries. Resource-based policies that specify the user or role in the Principal field are not limited by the permissions boundary. An explicit deny in any of these policies overrides the allow. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. • Service control policies (SCPs) – SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU) in AWS Organizations. AWS Organizations is a service for grouping and centrally managing multiple AWS accounts that your business owns. If you enable all features in an organization, then you can apply service control policies (SCPs) to any or all of your accounts. The SCP limits permissions for entities in member accounts, including each AWS account root user. For more information about Organizations and SCPs, see Service control policies in the AWS Organizations User Guide. • Resource control policies (RCPs) – RCPs are JSON policies that you can use to set the maximum available permissions for resources in your accounts without updating the IAM policies attached to each resource that you own. The RCP limits permissions for resources in member accounts and can impact the effective permissions for identities, including the AWS account root user, regardless of whether they belong to your organization. For more information about Organizations and RCPs, including a list of AWS services that support RCPs, see Resource control policies (RCPs) in the AWS Organizations User Guide. • Session policies – Session policies are advanced policies that you pass as a parameter when you programmatically create a temporary session for a role or federated user. The resulting session's permissions are the intersection of the user or role's identity-based policies and the session policies. Permissions can also come from a resource-based policy. An explicit deny in any of these policies overrides the allow. For more information, see Session policies in the IAM User Guide. Managing access using policies 45 AWS Supply Chain Multiple policy types Administrator Guide When multiple types of policies apply to a request, the resulting permissions are more complicated to understand. To learn how AWS determines whether to allow a request when multiple policy types are
|
supplychain-ag-015
|
supplychain-ag.pdf
| 15 |
session for a role or federated user. The resulting session's permissions are the intersection of the user or role's identity-based policies and the session policies. Permissions can also come from a resource-based policy. An explicit deny in any of these policies overrides the allow. For more information, see Session policies in the IAM User Guide. Managing access using policies 45 AWS Supply Chain Multiple policy types Administrator Guide When multiple types of policies apply to a request, the resulting permissions are more complicated to understand. To learn how AWS determines whether to allow a request when multiple policy types are involved, see Policy evaluation logic in the IAM User Guide. How AWS Supply Chain works with IAM Before you use IAM to manage access to AWS Supply Chain, learn what IAM features are available to use with AWS Supply Chain. IAM features you can use with AWS Supply Chain IAM feature AWS Supply Chain support Identity-based policies Resource-based policies Policy actions Policy resources Policy condition keys Temporary credentials Forward access sessions (FAS) Service roles Service-linked roles Yes No Yes Yes Yes Yes Yes Yes No To get a high-level view of how AWS Supply Chain and other AWS services work with most IAM features, see AWS services that work with IAM in the IAM User Guide. Identity-based policies for AWS Supply Chain Supports identity-based policies: Yes How AWS Supply Chain works with IAM 46 AWS Supply Chain Administrator Guide Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. With IAM identity-based policies, you can specify allowed or denied actions and resources as well as the conditions under which actions are allowed or denied. You can't specify the principal in an identity-based policy because it applies to the user or role to which it is attached. To learn about all of the elements that you can use in a JSON policy, see IAM JSON policy elements reference in the IAM User Guide. Identity-based policy examples for AWS Supply Chain To view examples of AWS Supply Chain identity-based policies, see Identity-based policy examples for AWS Supply Chain. Resource-based policies within AWS Supply Chain Supports resource-based policies: No Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a specific resource. For the resource where the policy is attached, the policy defines what actions a specified principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. To enable cross-account access, you can specify an entire account or IAM entities in another account as the principal in a resource-based policy. Adding a cross-account principal to a resource- based policy is only half of establishing the trust relationship. When the principal and the resource are in different AWS accounts, an IAM administrator in the trusted account must also grant the principal entity (user or role) permission to access the resource. They grant permission by attaching an identity-based policy to the entity. However, if a resource-based policy grants access to a principal in the same account, no additional identity-based policy is required. For more information, see Cross account resource access in IAM in the IAM User Guide. Policy actions for AWS Supply Chain Supports policy actions: Yes How AWS Supply Chain works with IAM 47 AWS Supply Chain Administrator Guide Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Action element of a JSON policy describes the actions that you can use to allow or deny access in a policy. Policy actions usually have the same name as the associated AWS API operation. There are some exceptions, such as permission-only actions that don't have a matching API operation. There are also some operations that require multiple actions in a policy. These additional actions are called dependent actions. Include actions in a policy to grant permissions to perform the associated operation. Policy actions in AWS Supply Chain use the following prefix before the action: scn To specify multiple actions in a single statement, separate them with commas. "Action": [ "scn:action1", "scn:action2" ] To view examples of AWS Supply Chain identity-based policies, see Identity-based policy examples for AWS Supply Chain. Policy resources for AWS
|
supplychain-ag-016
|
supplychain-ag.pdf
| 16 |
operation. There are some exceptions, such as permission-only actions that don't have a matching API operation. There are also some operations that require multiple actions in a policy. These additional actions are called dependent actions. Include actions in a policy to grant permissions to perform the associated operation. Policy actions in AWS Supply Chain use the following prefix before the action: scn To specify multiple actions in a single statement, separate them with commas. "Action": [ "scn:action1", "scn:action2" ] To view examples of AWS Supply Chain identity-based policies, see Identity-based policy examples for AWS Supply Chain. Policy resources for AWS Supply Chain Supports policy resources: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Resource JSON policy element specifies the object or objects to which the action applies. Statements must include either a Resource or a NotResource element. As a best practice, specify a resource using its Amazon Resource Name (ARN). You can do this for actions that support a specific resource type, known as resource-level permissions. How AWS Supply Chain works with IAM 48 AWS Supply Chain Administrator Guide For actions that don't support resource-level permissions, such as listing operations, use a wildcard (*) to indicate that the statement applies to all resources. "Resource": "*" To view examples of AWS Supply Chain identity-based policies, see Identity-based policy examples for AWS Supply Chain. Policy condition keys for AWS Supply Chain Supports service-specific policy condition keys: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Condition element (or Condition block) lets you specify conditions in which a statement is in effect. The Condition element is optional. You can create conditional expressions that use condition operators, such as equals or less than, to match the condition in the policy with values in the request. If you specify multiple Condition elements in a statement, or multiple keys in a single Condition element, AWS evaluates them using a logical AND operation. If you specify multiple values for a single condition key, AWS evaluates the condition using a logical OR operation. All of the conditions must be met before the statement's permissions are granted. You can also use placeholder variables when you specify conditions. For example, you can grant an IAM user permission to access a resource only if it is tagged with their IAM user name. For more information, see IAM policy elements: variables and tags in the IAM User Guide. AWS supports global condition keys and service-specific condition keys. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide. To view examples of AWS Supply Chain identity-based policies, see Identity-based policy examples for AWS Supply Chain. Using temporary credentials with AWS Supply Chain Supports temporary credentials: Yes How AWS Supply Chain works with IAM 49 AWS Supply Chain Administrator Guide Some AWS services don't work when you sign in using temporary credentials. For additional information, including which AWS services work with temporary credentials, see AWS services that work with IAM in the IAM User Guide. You are using temporary credentials if you sign in to the AWS Management Console using any method except a user name and password. For example, when you access AWS using your company's single sign-on (SSO) link, that process automatically creates temporary credentials. You also automatically create temporary credentials when you sign in to the console as a user and then switch roles. For more information about switching roles, see Switch from a user to an IAM role (console) in the IAM User Guide. You can manually create temporary credentials using the AWS CLI or AWS API. You can then use those temporary credentials to access AWS. AWS recommends that you dynamically generate temporary credentials instead of using long-term access keys. For more information, see Temporary security credentials in IAM. Forward access sessions for AWS Supply Chain Supports forward access sessions (FAS): Yes When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a different service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. Service roles for AWS Supply Chain Supports service roles: Yes A service role is
|
supplychain-ag-017
|
supplychain-ag.pdf
| 17 |
When you use some services, you might perform an action that then initiates another action in a different service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. Service roles for AWS Supply Chain Supports service roles: Yes A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. Warning Changing the permissions for a service role might break AWS Supply Chain functionality. Edit service roles only when AWS Supply Chain provides guidance to do so. How AWS Supply Chain works with IAM 50 AWS Supply Chain Administrator Guide Service-linked roles for AWS Supply Chain Supports service-linked roles: No A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. For details about creating or managing service-linked roles, see AWS services that work with IAM. Find a service in the table that includes a Yes in the Service-linked role column. Choose the Yes link to view the service-linked role documentation for that service. Identity-based policy examples for AWS Supply Chain By default, users and roles don't have permission to create or modify AWS Supply Chain resources. They also can't perform tasks by using the AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS API. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. To learn how to create an IAM identity-based policy by using these example JSON policy documents, see Creating IAM policies in the IAM User Guide. Topics • Policy best practices Policy best practices Identity-based policies determine whether someone can create, access, or delete AWS Supply Chain resources in your account. These actions can incur costs for your AWS account. When you create or edit identity-based policies, follow these guidelines and recommendations: • Get started with AWS managed policies and move toward least-privilege permissions – To get started granting permissions to your users and workloads, use the AWS managed policies that grant permissions for many common use cases. They are available in your AWS account. We recommend that you reduce permissions further by defining AWS customer managed policies that are specific to your use cases. For more information, see AWS managed policies or AWS managed policies for job functions in the IAM User Guide. Identity-based policy examples 51 AWS Supply Chain Administrator Guide • Apply least-privilege permissions – When you set permissions with IAM policies, grant only the permissions required to perform a task. You do this by defining the actions that can be taken on specific resources under specific conditions, also known as least-privilege permissions. For more information about using IAM to apply permissions, see Policies and permissions in IAM in the IAM User Guide. • Use conditions in IAM policies to further restrict access – You can add a condition to your policies to limit access to actions and resources. For example, you can write a policy condition to specify that all requests must be sent using SSL. You can also use conditions to grant access to service actions if they are used through a specific AWS service, such as AWS CloudFormation. For more information, see IAM JSON policy elements: Condition in the IAM User Guide. • Use IAM Access Analyzer to validate your IAM policies to ensure secure and functional permissions – IAM Access Analyzer validates new and existing policies so that the policies adhere to the IAM policy language (JSON) and IAM best practices. IAM Access Analyzer provides more than 100 policy checks and actionable recommendations to help you author secure and functional policies. For more information, see Validate policies with IAM Access Analyzer in the IAM User Guide. • Require multi-factor authentication (MFA) – If you have a scenario that requires IAM users or a root user in your AWS account, turn on MFA for additional security. To require MFA when API operations are called, add MFA conditions to your policies. For more
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.