Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
al2023-ug-054	al2023-ug.pdf	54	can create and conﬁgure ﬁle systems quickly and easily. The service manages all the ﬁle storage infrastructure for you, meaning that you can avoid the complexity of deploying, patching, and maintaining complex ﬁle system conﬁgurations. Amazon EFS supports the Network File System version 4 (NFSv4.1 and NFSv4.0) protocol, so the applications and tools that you use today work seamlessly with Amazon EFS. Multiple compute instances, including Amazon EC2, Amazon ECS, and AWS Lambda, can access an Amazon EFS ﬁle system at the same time. Therefore, an EFS ﬁle system can provide a common data source for workloads and applications that are running on more than one compute instance or server. Installing amazon-efs-utils on AL2023 The amazon-efs-utils package is available in the AL2023 repositories to be installed and used to access Amazon EFS ﬁle systems. Install the amazon-efs-utils package on AL2023 • Install amazon-efs-utils using the following command. $ dnf -y install amazon-efs-utils Custom Amazon ECS-optimized AMI 278 Amazon Linux 2023 User Guide Mounting an Amazon EFS ﬁle system on AL2023 After amazon-efs-utils is installed, you can mount an Amazon EFS ﬁle system on your AL2023 instance. Mount an Amazon EFS ﬁle system on AL2023 • To mount using the ﬁle system id, use the following command. sudo mount -t efs file-system-id efs-mount-point/ You can also mount the ﬁle system so that data in transit is encrypted using TLS, or by using the DNS name or mount target IP instead of the ﬁle system id. For more information, see Mounting on Amazon Linux instances using the EFS mount helper. Using Amazon EMR built on AL2023 Amazon EMR is a web service that makes it easy to process vast amounts of data eﬃciently using Apache Hadoop and services oﬀered by AWS. AL2023 based Amazon EMR releases Amazon EMR release 7.0.0 was the ﬁrst release built on AL2023. With this release, AL2023 is the base operating system for Amazon EMR, bringing all the advantages of AL2023 to Amazon EMR. For more information, see the Amazon EMR 7.0.0 release notes. AL2023 based Amazon EMR on EKS Amazon EMR on EKS 6.13 was the ﬁrst release introducing AL2023 as an option. With this release, you can launch Spark with AL2023 as the operating system, together with Java 17 runtime. For more information, see the Amazon EMR on EKS 6.13 release notes, and all Amazon EMR on EKS release notes. Mounting Amazon EFS ﬁle system 279 Amazon Linux 2023 User Guide Using AL2023 in AWS Lambda With AWS Lambda, you can run code without provisioning or managing servers. You pay only for the compute time that you consume–there's no charge when your code isn't running. You can run code for virtually any type of application or backend service–all with zero administration. Just upload your code and Lambda takes care of everything required to run and scale your code with high availability. AL2023 provided.al2023 managed runtime and container image The provided.al2023 base runtime is based on the AL2023 minimal container image, and provides an AL2023 based Lambda managed runtime and container base image. Because the provided.al2023 runtime is based on the AL2023 minimal container image, it is substantially smaller at less than 40 MB than the provided.al2 runtime at around 109 MB. For more information, see Lambda runtimes and Working with Lambda container images. AL2023 based Lambda runtimes Future releases of managed language runtimes, such as Node.js 20, Python 3.12, Java 21, and .NET 8, are based on AL2023 and will use provided.al2023 as the base image as described in the announcement of AL2023 based runtimes . AL2023 based Lambda functions • AL2023 Lambda functions written in Go • AL2023 Lambda functions written in Rust For more information, see Lambda runtimes in the AWS Lambda Developer Guide. AL2023 on AWS Lambda 280 Amazon Linux 2023 Tutorials User Guide The following tutorials show you how to perform common tasks using Amazon EC2 instances running Amazon Linux 2023 (AL2023). For video tutorials, see AWS Instructional videos and labs. For AL2 instructions, see Tutorials for Amazon EC2 instances running Linux in the Amazon EC2 User Guide. Tutorials • Tutorial: Install a LAMP server on AL2023 • Tutorial: Conﬁgure SSL/TLS on AL2023 • Tutorial: Host a WordPress blog on AL2023 • Tutorial: Redis 6 to Valkey Transition on AL2023 • Tutorial: Install the GNOME desktop environment on AL2023 • Tutorial: Conﬁgure TigerVNC server on AL2023 Tutorial: Install a LAMP server on AL2023 The following procedures help you install an Apache web server with PHP and MariaDB (a community-developed fork of MySQL) support on your AL2023 instance (sometimes called a LAMP web server or LAMP stack). You can use this server to host a static website or deploy a dynamic PHP application that reads and writes information to a database. Important These procedures are intended for use with AL2023. If you are
al2023-ug-055	al2023-ug.pdf	55	Tutorial: Redis 6 to Valkey Transition on AL2023 • Tutorial: Install the GNOME desktop environment on AL2023 • Tutorial: Conﬁgure TigerVNC server on AL2023 Tutorial: Install a LAMP server on AL2023 The following procedures help you install an Apache web server with PHP and MariaDB (a community-developed fork of MySQL) support on your AL2023 instance (sometimes called a LAMP web server or LAMP stack). You can use this server to host a static website or deploy a dynamic PHP application that reads and writes information to a database. Important These procedures are intended for use with AL2023. If you are trying to set up a LAMP web server on a diﬀerent distribution, such as Ubuntu or Red Hat Enterprise Linux, this tutorial will not work. For Ubuntu, see the following Ubuntu community documentation: ApacheMySQLPHP. For other distributions, see their speciﬁc documentation. Tasks • Step 1: Prepare the LAMP server • Step 2: Test your LAMP server Install LAMP on AL2023 281 Amazon Linux 2023 User Guide • Step 3: Secure the database server • Step 4: (Optional) Install phpMyAdmin • Troubleshoot • Related topics Step 1: Prepare the LAMP server Prerequisites • This tutorial assumes that you have already launched a new instance using AL2023, with a public DNS name that is reachable from the internet. For more information, see AL2023 on Amazon EC2. You must also have conﬁgured your security group to allow SSH (port 22), HTTP (port 80), and HTTPS (port 443) connections. For more information about these prerequisites, see Authorize inbound traﬃc for your Linux instances in the Amazon EC2 User Guide. • The following procedure installs the latest PHP version available on AL2023, currently 8.1. If you plan to use PHP applications other than those described in this tutorial, you should check their compatibility with 8.1. To prepare the LAMP server 1. Connect to your instance. For more information, see Connecting to AL2023 instances. 2. To ensure that all of your software packages are up to date, perform a quick software update on your instance. This process might take a few minutes, but it is important to make sure that you have the latest security updates and bug ﬁxes. The -y option installs the updates without asking for conﬁrmation. If you would like to examine the updates before installing, you can omit this option. [ec2-user ~]$ sudo dnf upgrade -y 3. Install the latest versions of Apache web server and PHP packages for AL2023. [ec2-user ~]$ sudo dnf install -y httpd wget php-fpm php-mysqli php-json php php- devel 4. Install the MariaDB software packages. Use the dnf install command to install multiple software packages and all related dependencies at the same time. Step 1: Prepare the LAMP server 282 Amazon Linux 2023 User Guide [ec2-user ~]$ sudo dnf install mariadb105-server You can view the current versions of these packages using the following command: [ec2-user ~]$ sudo dnf info package_name Example: [root@ip-172-31-25-170 ec2-user]# dnf info mariadb105 Last metadata expiration check: 0:00:16 ago on Tue Feb 14 21:35:13 2023. Installed Packages Name : mariadb105 Epoch : 3 Version : 10.5.16 Release : 1.amzn2023.0.6 Architecture : x86_64 Size : 18 M Source : mariadb105-10.5.16-1.amzn2023.0.6.src.rpm Repository : @System From repo : amazonlinux Summary : A very fast and robust SQL database server URL : http://mariadb.org License : GPLv2 and LGPLv2 Description : MariaDB is a community developed fork from MySQL - a multi-user, multi-threaded : SQL database server. It is a client/server implementation consisting of : a server daemon (mariadbd) and many different client programs and libraries. : The base package contains the standard MariaDB/MySQL client programs and : utilities. 5. Start the Apache web server. [ec2-user ~]$ sudo systemctl start httpd 6. Use the systemctl command to conﬁgure the Apache web server to start at each system boot. [ec2-user ~]$ sudo systemctl enable httpd Step 1: Prepare the LAMP server 283 Amazon Linux 2023 User Guide You can verify that httpd is on by running the following command: [ec2-user ~]$ sudo systemctl is-enabled httpd 7. Add a security rule to allow inbound HTTP (port 80) connections to your instance if you have not already done so. By default, a launch-wizard-N security group was created for your instance during launch. If you did not add additional security group rules, this group contains only a single rule to allow SSH connections. a. Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/. b. In the left navigator, choose Instances, and select your instance. c. On the Security tab, view the inbound rules. You should see the following rule: Port range Protocol Source 22 tcp 0.0.0.0/0 Warning Using 0.0.0.0/0 allows all IPv4 addresses to access your instance using SSH. This is acceptable for a short time in a test environment, but it's unsafe for production environments. In production, you authorize only a speciﬁc IP address
al2023-ug-056	al2023-ug.pdf	56	If you did not add additional security group rules, this group contains only a single rule to allow SSH connections. a. Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/. b. In the left navigator, choose Instances, and select your instance. c. On the Security tab, view the inbound rules. You should see the following rule: Port range Protocol Source 22 tcp 0.0.0.0/0 Warning Using 0.0.0.0/0 allows all IPv4 addresses to access your instance using SSH. This is acceptable for a short time in a test environment, but it's unsafe for production environments. In production, you authorize only a speciﬁc IP address or range of addresses to access your instance. d. If there is no inbound rule to allow HTTP (port 80) connections, you must the add rule now. Choose the link for the security group. Using the procedures in see Authorize inbound traﬃc for your Linux instances, add a new inbound security rule with the following values: • Type: HTTP • Protocol: TCP • Port Range: 80 • Source: Custom 8. Test your web server. In a web browser, type the public DNS address (or the public IP address) of your instance. If there is no content in /var/www/html, you should see the Apache test page, which will display the message "It works!". Step 1: Prepare the LAMP server 284 Amazon Linux 2023 User Guide You can get the public DNS for your instance using the Amazon EC2 console (check the Public IPv4 DNS column; if this column is hidden, choose Preferences (the gear-shaped icon) and toggle on Public IPv4 DNS). Verify that the security group for the instance contains a rule to allow HTTP traﬃc on port 80. For more information, see Add rules to security group. Important If you are not using Amazon Linux, you might also need to conﬁgure the ﬁrewall on your instance to allow these connections. For more information about how to conﬁgure the ﬁrewall, see the documentation for your speciﬁc distribution. Apache httpd serves ﬁles that are kept in a directory called the Apache document root. The Amazon Linux Apache document root is /var/www/html, which by default is owned by root. To allow the ec2-user account to manipulate ﬁles in this directory, you must modify the ownership and permissions of the directory. There are many ways to accomplish this task. In this tutorial, you add ec2-user to the apache group to give the apache group ownership of the / var/www directory and assign write permissions to the group. To set ﬁle permissions 1. Add your user (in this case, ec2-user) to the apache group. [ec2-user ~]$ sudo usermod -a -G apache ec2-user 2. Log out and then log back in again to pick up the new group, and then verify your membership. a. Log out (use the exit command or close the terminal window): [ec2-user ~]$ exit b. To verify your membership in the apache group, reconnect to your instance, and then run the following command: [ec2-user ~]$ groups Step 1: Prepare the LAMP server 285 Amazon Linux 2023 User Guide ec2-user adm wheel apache systemd-journal 3. Change the group ownership of /var/www and its contents to the apache group. [ec2-user ~]$ sudo chown -R ec2-user:apache /var/www 4. To add group write permissions and to set the group ID on future subdirectories, change the directory permissions of /var/www and its subdirectories. [ec2-user ~]$ sudo chmod 2775 /var/www && find /var/www -type d -exec sudo chmod 2775 {} \; 5. To add group write permissions, recursively change the ﬁle permissions of /var/www and its subdirectories: [ec2-user ~]$ find /var/www -type f -exec sudo chmod 0664 {} \; Now, ec2-user (and any future members of the apache group) can add, delete, and edit ﬁles in the Apache document root, enabling you to add content, such as a static website or a PHP application. To secure your web server (Optional) A web server running the HTTP protocol provides no transport security for the data that it sends or receives. When you connect to an HTTP server using a web browser, the URLs that you visit, the content of webpages that you receive, and the contents (including passwords) of any HTML forms that you submit are all visible to eavesdroppers anywhere along the network pathway. The best practice for securing your web server is to install support for HTTPS (HTTP Secure), which protects your data with SSL/TLS encryption. For information about enabling HTTPS on your server, see Tutorial: Conﬁgure SSL/TLS on AL2023. Step 2: Test your LAMP server If your server is installed and running, and your ﬁle permissions are set correctly, your ec2-user account should be able to create a PHP ﬁle in the /var/www/html directory that is available from the internet. Step 2: Test your LAMP server 286 Amazon Linux 2023 To test your LAMP server 1.
al2023-ug-057	al2023-ug.pdf	57	eavesdroppers anywhere along the network pathway. The best practice for securing your web server is to install support for HTTPS (HTTP Secure), which protects your data with SSL/TLS encryption. For information about enabling HTTPS on your server, see Tutorial: Conﬁgure SSL/TLS on AL2023. Step 2: Test your LAMP server If your server is installed and running, and your ﬁle permissions are set correctly, your ec2-user account should be able to create a PHP ﬁle in the /var/www/html directory that is available from the internet. Step 2: Test your LAMP server 286 Amazon Linux 2023 To test your LAMP server 1. Create a PHP ﬁle in the Apache document root. User Guide [ec2-user ~]$ echo "<?php phpinfo(); ?>" > /var/www/html/phpinfo.php If you get a "Permission denied" error when trying to run this command, try logging out and logging back in again to pick up the proper group permissions that you conﬁgured in To set ﬁle permissions. 2. In a web browser, type the URL of the ﬁle that you just created. This URL is the public DNS address of your instance followed by a forward slash and the ﬁle name. For example: http://my.public.dns.amazonaws.com/phpinfo.php You should see the PHP information page: Step 2: Test your LAMP server 287 Amazon Linux 2023 User Guide If you do not see this page, verify that the /var/www/html/phpinfo.php ﬁle was created properly in the previous step. You can also verify that all of the required packages were installed with the following command. [ec2-user ~]$ sudo dnf list installed httpd mariadb-server php-mysqlnd If any of the required packages are not listed in your output, install them with the sudo yum install package command. Step 2: Test your LAMP server 288 Amazon Linux 2023 User Guide 3. Delete the phpinfo.php ﬁle. Although this can be useful information, it should not be broadcast to the internet for security reasons. [ec2-user ~]$ rm /var/www/html/phpinfo.php You should now have a fully functional LAMP web server. If you add content to the Apache document root at /var/www/html, you should be able to view that content at the public DNS address for your instance. Step 3: Secure the database server The default installation of the MariaDB server has several features that are great for testing and development, but they should be disabled or removed for production servers. The mysql_secure_installation command walks you through the process of setting a root password and removing the insecure features from your installation. Even if you are not planning on using the MariaDB server, we recommend performing this procedure. To secure the MariaDB server 1. Start the MariaDB server. [ec2-user ~]$ sudo systemctl start mariadb 2. Run mysql_secure_installation. [ec2-user ~]$ sudo mysql_secure_installation a. When prompted, type a password for the root account. i. Type the current root password. By default, the root account does not have a password set. Press Enter. ii. Type Y to set a password, and type a secure password twice. For more information about creating a secure password, see https://identitysafe.norton.com/password- generator/. Make sure to store this password in a safe place. Setting a root password for MariaDB is only the most basic measure for securing your database. When you build or install a database-driven application, you typically Step 3: Secure the database server 289 Amazon Linux 2023 User Guide create a database service user for that application and avoid using the root account for anything but database administration. Type Y to remove the anonymous user accounts. Type Y to disable the remote root login. Type Y to remove the test database. Type Y to reload the privilege tables and save your changes. b. c. d. e. 3. (Optional) If you do not plan to use the MariaDB server right away, stop it. You can restart it when you need it again. [ec2-user ~]$ sudo systemctl stop mariadb 4. (Optional) If you want the MariaDB server to start at every boot, type the following command. [ec2-user ~]$ sudo systemctl enable mariadb Step 4: (Optional) Install phpMyAdmin phpMyAdmin is a web-based database management tool that you can use to view and edit the MySQL databases on your EC2 instance. Follow the steps below to install and conﬁgure phpMyAdmin on your Amazon Linux instance. Important We do not recommend using phpMyAdmin to access a LAMP server unless you have enabled SSL/TLS in Apache; otherwise, your database administrator password and other data are transmitted insecurely across the internet. For security recommendations from the developers, see Securing your phpMyAdmin installation. For general information about securing a web server on an EC2 instance, see Tutorial: Conﬁgure SSL/TLS on AL2023. To install phpMyAdmin 1. Install the required dependencies. [ec2-user ~]$ sudo dnf install php-mbstring php-xml -y 2. Restart Apache. Step 4: (Optional) Install phpMyAdmin 290 Amazon Linux 2023 User Guide [ec2-user ~]$ sudo systemctl restart httpd 3. Restart php-fpm. [ec2-user ~]$
al2023-ug-058	al2023-ug.pdf	58	not recommend using phpMyAdmin to access a LAMP server unless you have enabled SSL/TLS in Apache; otherwise, your database administrator password and other data are transmitted insecurely across the internet. For security recommendations from the developers, see Securing your phpMyAdmin installation. For general information about securing a web server on an EC2 instance, see Tutorial: Conﬁgure SSL/TLS on AL2023. To install phpMyAdmin 1. Install the required dependencies. [ec2-user ~]$ sudo dnf install php-mbstring php-xml -y 2. Restart Apache. Step 4: (Optional) Install phpMyAdmin 290 Amazon Linux 2023 User Guide [ec2-user ~]$ sudo systemctl restart httpd 3. Restart php-fpm. [ec2-user ~]$ sudo systemctl restart php-fpm 4. Navigate to the Apache document root at /var/www/html. [ec2-user ~]$ cd /var/www/html 5. Select a source package for the latest phpMyAdmin release from https:// www.phpmyadmin.net/downloads. To download the ﬁle directly to your instance, copy the link and paste it into a wget command, as in this example: [ec2-user html]$ wget https://www.phpmyadmin.net/downloads/phpMyAdmin-latest-all- languages.tar.gz 6. Create a phpMyAdmin folder and extract the package into it with the following command. [ec2-user html]$ mkdir phpMyAdmin && tar -xvzf phpMyAdmin-latest-all- languages.tar.gz -C phpMyAdmin --strip-components 1 7. Delete the phpMyAdmin-latest-all-languages.tar.gz tarball. [ec2-user html]$ rm phpMyAdmin-latest-all-languages.tar.gz 8. (Optional) If the MySQL server is not running, start it now. [ec2-user ~]$ sudo systemctl start mariadb 9. In a web browser, type the URL of your phpMyAdmin installation. This URL is the public DNS address (or the public IP address) of your instance followed by a forward slash and the name of your installation directory. For example: http://my.public.dns.amazonaws.com/phpMyAdmin You should see the phpMyAdmin login page: Step 4: (Optional) Install phpMyAdmin 291 Amazon Linux 2023 User Guide 10. Log in to your phpMyAdmin installation with the root user name and the MySQL root password you created earlier. Your installation must still be conﬁgured before you put it into service. We suggest that you begin by manually creating the conﬁguration ﬁle, as follows: a. To start with a minimal conﬁguration ﬁle, use your favorite text editor to create a new ﬁle, and then copy the contents of config.sample.inc.php into it. b. Save the ﬁle as config.inc.php in the phpMyAdmin directory that contains index.php. c. Refer to post-ﬁle creation instructions in the Using the Setup script section of the phpMyAdmin installation instructions for any additional setup. For information about using phpMyAdmin, see the phpMyAdmin User Guide. Step 4: (Optional) Install phpMyAdmin 292 Amazon Linux 2023 Troubleshoot User Guide This section oﬀers suggestions for resolving common problems you might encounter while setting up a new LAMP server. I can't connect to my server using a web browser Perform the following checks to see if your Apache web server is running and accessible. • Is the web server running? You can verify that httpd is on by running the following command: [ec2-user ~]$ sudo systemctl is-enabled httpd If the httpd process is not running, repeat the steps described in To prepare the LAMP server. • Is the ﬁrewall correctly conﬁgured? Verify that the security group for the instance contains a rule to allow HTTP traﬃc on port 80. For more information, see Add rules to security group. I can't connect to my server using HTTPS Perform the following checks to see if your Apache web server is conﬁgured to support HTTPS. • Is the web server correctly conﬁgured? After you install Apache, the server is conﬁgured for HTTP traﬃc. To support HTTPS, enable TLS on the server and install an SSL certiﬁcate. For information, see Tutorial: Conﬁgure SSL/TLS on AL2023. • Is the ﬁrewall correctly conﬁgured? Verify that the security group for the instance contains a rule to allow HTTPS traﬃc on port 443. For more information, see Authorize inbound traﬃc for your Linux instances. Related topics For more information about transferring ﬁles to your instance or installing a WordPress blog on your web server, see the following documentation: Troubleshoot 293 Amazon Linux 2023 User Guide • Transfer ﬁles to your Linux instance using WinSCP in the Amazon EC2 User Guide. • Transfer ﬁles to Linux instances using an SCP client in the Amazon EC2 User Guide. • Tutorial: Host a WordPress blog on AL2023 For more information about the commands and software used in this tutorial, see the following webpages: • Apache web server: http://httpd.apache.org/ • MariaDB database server: https://mariadb.org/ • PHP programming language: http://php.net/ For more information about registering a domain name for your web server, or transferring an existing domain name to this host, see Creating and Migrating Domains and Subdomains to Amazon Route 53 in the Amazon Route 53 Developer Guide. Tutorial: Conﬁgure SSL/TLS on AL2023 Secure Sockets Layer/Transport Layer Security (SSL/TLS) creates an encrypted channel between a web server and web client that protects data in transit from being eavesdropped on. This tutorial explains how to add support manually for SSL/TLS on an EC2
al2023-ug-059	al2023-ug.pdf	59	following webpages: • Apache web server: http://httpd.apache.org/ • MariaDB database server: https://mariadb.org/ • PHP programming language: http://php.net/ For more information about registering a domain name for your web server, or transferring an existing domain name to this host, see Creating and Migrating Domains and Subdomains to Amazon Route 53 in the Amazon Route 53 Developer Guide. Tutorial: Conﬁgure SSL/TLS on AL2023 Secure Sockets Layer/Transport Layer Security (SSL/TLS) creates an encrypted channel between a web server and web client that protects data in transit from being eavesdropped on. This tutorial explains how to add support manually for SSL/TLS on an EC2 instance with AL2023 and Apache web server. This tutorial assumes that you are not using a load balancer. If you are using Elastic Load Balancing, you can choose to conﬁgure SSL oﬄoad on the load balancer, using a certiﬁcate from AWS Certiﬁcate Manager instead. For historical reasons, web encryption is often referred to simply as SSL. While web browsers still support SSL, its successor protocol TLS is less vulnerable to attack. AL2023 disables server-side support for all versions of SSL by default. Security standards bodies consider TLS 1.0 to be unsafe. TLS 1.0 and TLS 1.1 were formally deprecated in March 2021. This tutorial contains guidance based exclusively on enabling TLS 1.2. TLS 1.3 was ﬁnalized in 2018 and is available in AL2 as long as the underlying TLS library (OpenSSL in this tutorial) is supported and enabled. Clients must support TLS 1.2 or later by June 28, 2023. For more information about the updated encryption standards, see RFC 7568 and RFC 8446. This tutorial refers to modern web encryption simply as TLS. Conﬁgure SSL/TLS on AL2023 294 Amazon Linux 2023 Important User Guide These procedures are intended for use with AL2023. If you are trying to set up an EC2 instance running a diﬀerent distribution, or an instance running an old version of Amazon Linux, some procedures in this tutorial might not work. For Ubuntu, see the following Ubuntu community documentation: Open SSL on Ubuntu. For Red Hat Enterprise Linux, see the following: Setting up the Apache HTTP Web Server. For other distributions, see their speciﬁc documentation. Note Alternatively, you can use AWS Certiﬁcate Manager (ACM) for AWS Nitro enclaves, which is an enclave application that allows you to use public and private SSL/TLS certiﬁcates with your web applications and servers running on Amazon EC2 instances with AWS Nitro Enclaves. Nitro Enclaves is an Amazon EC2 capability that enables creation of isolated compute environments to protect and securely process highly sensitive data, such as SSL/ TLS certiﬁcates and private keys. ACM for Nitro Enclaves works with nginx running on your Amazon EC2 Linux instance to create private keys, to distribute certiﬁcates and private keys, and to manage certiﬁcate renewals. To use ACM for Nitro Enclaves, you must use an enclave-enabled Linux instance. For more information, see What is AWS Nitro Enclaves? and AWS Certiﬁcate Manager for Nitro Enclaves in the AWS Nitro Enclaves User Guide. Contents • Prerequisites • Step 1: Enable TLS on the server • Step 2: Obtain a CA-signed certiﬁcate • Step 3: Test and harden the security conﬁguration • Troubleshoot Prerequisites Before you begin this tutorial, complete the following steps: Prerequisites 295 Amazon Linux 2023 User Guide • Launch an EBS-backed AL2023 instance. For more information, see AL2023 on Amazon EC2. • Conﬁgure your security groups to allow your instance to accept connections on the following TCP ports: • SSH (port 22) • HTTP (port 80) • HTTPS (port 443) For more information, see Authorize inbound traﬃc for your Linux instances in the Amazon EC2 User Guide. • Install the Apache web server. For step-by-step instructions, see Tutorial: Install a LAMP server on AL2023. Only the httpd package and its dependencies are needed, so you can ignore the instructions involving PHP and MariaDB. • To identify and authenticate websites, the TLS public key infrastructure (PKI) relies on the Domain Name System (DNS). To use your EC2 instance to host a public website, you need to register a domain name for your web server or transfer an existing domain name to your Amazon EC2 host. Numerous third-party domain registration and DNS hosting services are available for this, or you can use Amazon Route 53. Step 1: Enable TLS on the server This procedure takes you through the process of setting up TLS on AL2023 with a self-signed digital certiﬁcate. Note A self-signed certiﬁcate is acceptable for testing but not production. If you expose your self-signed certiﬁcate to the internet, visitors to your site are greeted by security warnings. To enable TLS on a server 1. Connect to your instance and conﬁrm that Apache is running. For more information, see Connecting to AL2023 instances. [ec2-user ~]$ sudo systemctl is-enabled httpd Step 1: Enable TLS on the server
al2023-ug-060	al2023-ug.pdf	60	this, or you can use Amazon Route 53. Step 1: Enable TLS on the server This procedure takes you through the process of setting up TLS on AL2023 with a self-signed digital certiﬁcate. Note A self-signed certiﬁcate is acceptable for testing but not production. If you expose your self-signed certiﬁcate to the internet, visitors to your site are greeted by security warnings. To enable TLS on a server 1. Connect to your instance and conﬁrm that Apache is running. For more information, see Connecting to AL2023 instances. [ec2-user ~]$ sudo systemctl is-enabled httpd Step 1: Enable TLS on the server 296 Amazon Linux 2023 User Guide If the returned value is not "enabled," start Apache and set it to start each time the system boots. [ec2-user ~]$ sudo systemctl start httpd && sudo systemctl enable httpd 2. To ensure that all of your software packages are up to date, perform a quick software update on your instance. This process may take a few minutes, but it is important to make sure that you have the latest security updates and bug ﬁxes. Note The -y option installs the updates without asking for conﬁrmation. If you would like to examine the updates before installing, you can omit this option. [ec2-user ~]$ sudo dnf install openssl mod_ssl 3. After you enter the following command, you will be taken to a prompt where you can enter information about your site. [ec2-user ~]$ sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout / etc/pki/tls/private/apache-selfsigned.key -out /etc/pki/tls/certs/apache- selfsigned.crt This generates a new ﬁle apache-selfsigned.crt in the /etc/pki/tls/ certs/ directory. The speciﬁed ﬁle name matches the default that is assigned in the SSLCertiﬁcateFile directive in /etc/httpd/conf.d/ssl.conf. Your instance now has the following ﬁles that you use to conﬁgure your secure server and create a certiﬁcate for testing: • /etc/httpd/conf.d/ssl.conf The conﬁguration ﬁle for mod_ssl. It contains directives telling Apache where to ﬁnd encryption keys and certiﬁcates, the TLS protocol versions to allow, and the encryption ciphers to accept. This will be your local certiﬁcate ﬁle: • /etc/pki/tls/certs/apache-selfsigned.crt Step 1: Enable TLS on the server 297 Amazon Linux 2023 User Guide This ﬁle contains both a self-signed certiﬁcate and the certiﬁcate's private key. Apache requires the certiﬁcate and key to be in PEM format, which consists of Base64-encoded ASCII characters framed by "BEGIN" and "END" lines, as in the following abbreviated example. -----BEGIN PRIVATE KEY----- MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQD2KKx/8Zk94m1q 3gQMZF9ZN66Ls19+3tHAgQ5Fpo9KJDhzLjOOCI8u1PTcGmAah5kEitCEc0wzmNeo BCl0wYR6G0rGaKtK9Dn7CuIjvubtUysVyQoMVPQ97ldeakHWeRMiEJFXg6kZZ0vr GvwnKoMh3DlK44D9dX7IDua2PlYx5+eroA+1Lqf32ZSaAO0bBIMIYTHigwbHMZoT ... 56tE7THvH7vOEf4/iUOsIrEzaMaJ0mqkmY1A70qQGQKBgBF3H1qNRNHuyMcPODFs 27hDzPDinrquSEvoZIggkDMlh2irTiipJ/GhkvTpoQlv0fK/VXw8vSgeaBuhwJvS LXU9HvYq0U6O4FgD3nAyB9hI0BE13r1HjUvbjT7moH+RhnNz6eqqdscCS09VtRAo 4QQvAqOa8UheYeoXLdWcHaLP -----END PRIVATE KEY----- -----BEGIN CERTIFICATE----- MIIEazCCA1OgAwIBAgICWxQwDQYJKoZIhvcNAQELBQAwgbExCzAJBgNVBAYTAi0t MRIwEAYDVQQIDAlTb21lU3RhdGUxETAPBgNVBAcMCFNvbWVDaXR5MRkwFwYDVQQK DBBTb21lT3JnYW5pemF0aW9uMR8wHQYDVQQLDBZTb21lT3JnYW5pemF0aW9uYWxV bml0MRkwFwYDVQQDDBBpcC0xNzItMzEtMjAtMjM2MSQwIgYJKoZIhvcNAQkBFhVy ... z5rRUE/XzxRLBZOoWZpNWTXJkQ3uFYH6s/sBwtHpKKZMzOvDedREjNKAvk4ws6F0 CuIjvubtUysVyQoMVPQ97ldeakHWeRMiEJFXg6kZZ0vrGvwnKoMh3DlK44D9dlU3 WanXWehT6FiSZvB4sTEXXJN2jdw8g+sHGnZ8zCOsclknYhHrCVD2vnBlZJKSZvak 3ZazhBxtQSukFMOnWPP2a0DMMFGYUHOd0BQE8sBJxg== -----END CERTIFICATE----- The ﬁle names and extensions are a convenience and have no eﬀect on function. For example, you can call a certiﬁcate cert.crt, cert.pem, or any other ﬁle name, so long as the related directive in the ssl.conf ﬁle uses the same name. Note When you replace the default TLS ﬁles with your own customized ﬁles, be sure that they are in PEM format. 4. Restart Apache. Step 1: Enable TLS on the server 298 Amazon Linux 2023 User Guide [ec2-user ~]$ sudo systemctl restart httpd Note Make sure that TCP port 443 is accessible on your EC2 instance, as previously described. 5. Your Apache web server should now support HTTPS (secure HTTP) over port 443. Test it by entering the IP address or fully qualiﬁed domain name of your EC2 instance into a browser URL bar with the preﬁx https://. Because you are connecting to a site with a self-signed, untrusted host certiﬁcate, your browser may display a series of security warnings. Override the warnings and proceed to the site. If the default Apache test page opens, it means that you have successfully conﬁgured TLS on your server. All data passing between the browser and server is now encrypted. Note To prevent site visitors from encountering warning screens, you must obtain a trusted, CA-signed certiﬁcate that not only encrypts, but also publicly authenticates you as the owner of the site. Step 2: Obtain a CA-signed certiﬁcate You can use the following process to obtain a CA-signed certiﬁcate: • Generate a certiﬁcate signing request (CSR) from a private key • Submit the CSR to a certiﬁcate authority (CA) • Obtain a signed host certiﬁcate • Conﬁgure Apache to use the certiﬁcate A self-signed TLS X.509 host certiﬁcate is cryptologically identical to a CA-signed certiﬁcate. The diﬀerence is social, not mathematical. A CA promises, at a minimum, to validate a domain's Step 2: Obtain a CA-signed certiﬁcate 299 Amazon Linux 2023 User Guide ownership before issuing a certiﬁcate to an applicant. Each web browser contains a list of CAs trusted by the browser vendor to do this. An X.509 certiﬁcate consists primarily of a public key that corresponds to your private server key, and a signature by the CA that is cryptographically tied to the public key. When a
al2023-ug-061	al2023-ug.pdf	61	use the certiﬁcate A self-signed TLS X.509 host certiﬁcate is cryptologically identical to a CA-signed certiﬁcate. The diﬀerence is social, not mathematical. A CA promises, at a minimum, to validate a domain's Step 2: Obtain a CA-signed certiﬁcate 299 Amazon Linux 2023 User Guide ownership before issuing a certiﬁcate to an applicant. Each web browser contains a list of CAs trusted by the browser vendor to do this. An X.509 certiﬁcate consists primarily of a public key that corresponds to your private server key, and a signature by the CA that is cryptographically tied to the public key. When a browser connects to a web server over HTTPS, the server presents a certiﬁcate for the browser to check against its list of trusted CAs. If the signer is on the list, or accessible through a chain of trust consisting of other trusted signers, the browser negotiates a fast encrypted data channel with the server and loads the page. Certiﬁcates generally cost money because of the labor involved in validating the requests, so it pays to shop around. A few CAs oﬀer basic-level certiﬁcates free of charge. The most notable of these CAs is the Let's Encrypt project, which also supports the automation of the certiﬁcate creation and renewal process. For more information about using a Let's Encrypt certiﬁcate, see Get Certbot. If you plan to oﬀer commercial-grade services, AWS Certiﬁcate Manager is a good option. Underlying the host certiﬁcate is the key. As of 2019, government and industry groups recommend using a minimum key (modulus) size of 2048 bits for RSA keys intended to protect documents, through 2030. The default modulus size generated by OpenSSL in AL2023 is 2048 bits, which is suitable for use in a CA-signed certiﬁcate. In the following procedure, an optional step provided for those who want a customized key, for example, one with a larger modulus or using a diﬀerent encryption algorithm. Important These instructions for acquiring a CA-signed host certiﬁcate do not work unless you own a registered and hosted DNS domain. To obtain a CA-signed certiﬁcate 1. Connect to your instance and navigate to /etc/pki/tls/private/. This is the directory where you store the server's private key for TLS. If you prefer to use an existing host key to generate the CSR, skip to Step 3. For more information about connecting to your instance, see Connecting to AL2023 instances 2. (Optional) Generate a new private key. Here are some examples of key conﬁgurations. Any of the resulting keys works with your web server, but they vary in the degree and type of security that they implement. Step 2: Obtain a CA-signed certiﬁcate 300 Amazon Linux 2023 User Guide • Example 1: Create a default RSA host key. The resulting ﬁle, custom.key, is a 2048-bit RSA private key. [ec2-user ~]$ sudo openssl genrsa -out custom.key • Example 2: Create a stronger RSA key with a bigger modulus. The resulting ﬁle, custom.key, is a 4096-bit RSA private key. [ec2-user ~]$ sudo openssl genrsa -out custom.key 4096 • Example 3: Create a 4096-bit encrypted RSA key with password protection. The resulting ﬁle, custom.key, is a 4096-bit RSA private key encrypted with the AES-128 cipher. Important Encrypting the key provides greater security, but because an encrypted key requires a password, services depending on it cannot be auto-started. Each time you use this key, you must supply the password (in the preceding example, "abcde12345") over an SSH connection. [ec2-user ~]$ sudo openssl genrsa -aes128 -passout pass:abcde12345 -out custom.key 4096 • Example 4: Create a key using a non-RSA cipher. RSA cryptography can be relatively slow because of the size of its public keys, which are based on the product of two large prime numbers. However, it is possible to create keys for TLS that use non-RSA ciphers. Keys based on the mathematics of elliptic curves are smaller and computationally faster when delivering an equivalent level of security. [ec2-user ~]$ sudo openssl ecparam -name prime256v1 -out custom.key -genkey The result is a 256-bit elliptic curve private key using prime256v1, a "named curve" that OpenSSL supports. Its cryptographic strength is slightly greater than a 2048-bit RSA key, according to NIST. Step 2: Obtain a CA-signed certiﬁcate 301 Amazon Linux 2023 Note User Guide Not all CAs provide the same level of support for elliptic-curve-based keys as for RSA keys. Make sure that the new private key has highly restrictive ownership and permissions (owner=root, group=root, read/write for owner only). The commands would be as shown in the following example. [ec2-user ~]$ sudo chown root:root custom.key [ec2-user ~]$ sudo chmod 600 custom.key [ec2-user ~]$ ls -al custom.key The preceding commands yield the following result. -rw------- root root custom.key After you have created and conﬁgured a satisfactory key, you can create a CSR. 3. Create a CSR using your preferred key. The following example
al2023-ug-062	al2023-ug.pdf	62	User Guide Not all CAs provide the same level of support for elliptic-curve-based keys as for RSA keys. Make sure that the new private key has highly restrictive ownership and permissions (owner=root, group=root, read/write for owner only). The commands would be as shown in the following example. [ec2-user ~]$ sudo chown root:root custom.key [ec2-user ~]$ sudo chmod 600 custom.key [ec2-user ~]$ ls -al custom.key The preceding commands yield the following result. -rw------- root root custom.key After you have created and conﬁgured a satisfactory key, you can create a CSR. 3. Create a CSR using your preferred key. The following example uses custom.key. [ec2-user ~]$ sudo openssl req -new -key custom.key -out csr.pem OpenSSL opens a dialog and prompts you for the information shown in the following table. All of the ﬁelds except Common Name are optional for a basic, domain-validated host certiﬁcate. Name Description Example Country Name State or Province Name The two-letter ISO abbreviation for your country. US (=United States) The name of the state or province where your organization is located. This name cannot be abbreviated. Washington Step 2: Obtain a CA-signed certiﬁcate 302 Amazon Linux 2023 User Guide Name Description Locality Name The location of your organization, such as a city. Example Seattle Organizat ion Name The full legal name of your organization. Do not abbreviate your organization name. Example Corporation Organizat ional Unit Name Common Name Additional organizational information, if any. Example Dept www.example.com This value must exactly match the web address that you expect users to enter into a browser. Usually, this means a domain name with a preﬁxed hostname or alias in the form www.example.com . In testing with a self-signed certiﬁcate and no DNS resolution, the common name may consist of the hostname alone. CAs also oﬀer more expensive certiﬁcates that accept wild-card names such as *.example.com . Email Address The server administrator's email address. someone@example.com Finally, OpenSSL prompts you for an optional challenge password. This password applies only to the CSR and to transactions between you and your CA, so follow the CA's recommendations about this and the other optional ﬁeld, optional company name. The CSR challenge password has no eﬀect on server operation. The resulting ﬁle csr.pem contains your public key, your digital signature of your public key, and the metadata that you entered. 4. Submit the CSR to a CA. This usually consists of opening your CSR ﬁle in a text editor and copying the contents into a web form. At this time, you may be asked to supply one or more subject alternate names (SANs) to be placed on the certiﬁcate. If www.example.com is the common name, then example.com would be a good SAN, and vice versa. A visitor to your site Step 2: Obtain a CA-signed certiﬁcate 303 Amazon Linux 2023 User Guide entering either of these names would see an error-free connection. If your CA web form allows it, include the common name in the list of SANs. Some CAs include it automatically. After your request has been approved, you receive a new host certiﬁcate signed by the CA. You might also be instructed to download an intermediate certiﬁcate ﬁle that contains additional certiﬁcates needed to complete the CA's chain of trust. Note Your CA might send you ﬁles in multiple formats intended for various purposes. For this tutorial, you should only use a certiﬁcate ﬁle in PEM format, which is usually (but not always) marked with a .pem or .crt ﬁle extension. If you are uncertain which ﬁle to use, open the ﬁles with a text editor and ﬁnd the one containing one or more blocks beginning with the following line. - - - - -BEGIN CERTIFICATE - - - - - The ﬁle should also end with the following line. - - - -END CERTIFICATE - - - - - You can also test the ﬁle at the command line as shown in the following. [ec2-user certs]$ openssl x509 -in certificate.crt -text Verify that these lines appear in the ﬁle. Do not use ﬁles ending with .p7b, .p7c, or similar ﬁle extensions. 5. Place the new CA-signed certiﬁcate and any intermediate certiﬁcates in the /etc/pki/tls/ certs directory. Note There are several ways to upload your new certiﬁcate to your EC2 instance, but the most straightforward and informative way is to open a text editor (for example, vi, nano, or notepad) on both your local computer and your instance, and then copy and paste the ﬁle contents between them. You need root [sudo] permissions when performing these operations on the EC2 instance. This way, you can see immediately Step 2: Obtain a CA-signed certiﬁcate 304 Amazon Linux 2023 User Guide if there are any permission or path problems. Be careful, however, not to add any additional lines while copying the contents, or to change them in
al2023-ug-063	al2023-ug.pdf	63	new certiﬁcate to your EC2 instance, but the most straightforward and informative way is to open a text editor (for example, vi, nano, or notepad) on both your local computer and your instance, and then copy and paste the ﬁle contents between them. You need root [sudo] permissions when performing these operations on the EC2 instance. This way, you can see immediately Step 2: Obtain a CA-signed certiﬁcate 304 Amazon Linux 2023 User Guide if there are any permission or path problems. Be careful, however, not to add any additional lines while copying the contents, or to change them in any way. From inside the /etc/pki/tls/certs directory, check that the ﬁle ownership, group, and permission settings match the highly restrictive AL2023 defaults (owner=root, group=root, read/write for owner only). The following example shows the commands to use. [ec2-user certs]$ sudo chown root:root custom.crt [ec2-user certs]$ sudo chmod 600 custom.crt [ec2-user certs]$ ls -al custom.crt These commands should yield the following result. -rw------- root root custom.crt The permissions for the intermediate certiﬁcate ﬁle are less stringent (owner=root, group=root, owner can write, group can read, world can read). The following example shows the commands to use. [ec2-user certs]$ sudo chown root:root intermediate.crt [ec2-user certs]$ sudo chmod 644 intermediate.crt [ec2-user certs]$ ls -al intermediate.crt These commands should yield the following result. -rw-r--r-- root root intermediate.crt 6. Place the private key that you used to create the CSR in the /etc/pki/tls/private/ directory. Note There are several ways to upload your custom key to your EC2 instance, but the most straightforward and informative way is to open a text editor (for example, vi, nano, or notepad) on both your local computer and your instance, and then copy and paste the ﬁle contents between them. You need root [sudo] permissions when performing these operations on the EC2 instance. This way, you can see immediately if there are Step 2: Obtain a CA-signed certiﬁcate 305 Amazon Linux 2023 User Guide any permission or path problems. Be careful, however, not to add any additional lines while copying the contents, or to change them in any way. From inside the /etc/pki/tls/private directory, use the following commands to verify that the ﬁle ownership, group, and permission settings match the highly restrictive AL2023 defaults (owner=root, group=root, read/write for owner only). [ec2-user private]$ sudo chown root:root custom.key [ec2-user private]$ sudo chmod 600 custom.key [ec2-user private]$ ls -al custom.key These commands should yield the following result. -rw------- root root custom.key 7. Edit /etc/httpd/conf.d/ssl.conf to reﬂect your new certiﬁcate and key ﬁles. a. Provide the path and ﬁle name of the CA-signed host certiﬁcate in Apache's SSLCertificateFile directive: SSLCertificateFile /etc/pki/tls/certs/custom.crt b. If you received an intermediate certiﬁcate ﬁle (intermediate.crt in this example), provide its path and ﬁle name using Apache's SSLCACertificateFile directive: SSLCACertificateFile /etc/pki/tls/certs/intermediate.crt Note Some CAs combine the host certiﬁcate and the intermediate certiﬁcates in a single ﬁle, making the SSLCACertificateFile directive unnecessary. Consult the instructions provided by your CA. c. Provide the path and ﬁle name of the private key (custom.key in this example) in Apache's SSLCertificateKeyFile directive: SSLCertificateKeyFile /etc/pki/tls/private/custom.key Step 2: Obtain a CA-signed certiﬁcate 306 Amazon Linux 2023 User Guide 8. Save /etc/httpd/conf.d/ssl.conf and restart Apache. [ec2-user ~]$ sudo systemctl restart httpd 9. Test your server by entering your domain name into a browser URL bar with the preﬁx https://. Your browser should load the test page over HTTPS without generating errors. Step 3: Test and harden the security conﬁguration After your TLS is operational and exposed to the public, you should test how secure it really is. This is easy to do using online services such as Qualys SSL Labs, which performs a free and thorough analysis of your security setup. Based on the results, you may decide to harden the default security conﬁguration by controlling which protocols you accept, which ciphers you prefer, and which you exclude. For more information, see how Qualys formulates its scores. Important Real-world testing is crucial to the security of your server. Small conﬁguration errors may lead to serious security breaches and loss of data. Because recommended security practices change constantly in response to research and emerging threats, periodic security audits are essential to good server administration. On the Qualys SSL Labs site, enter the fully qualiﬁed domain name of your server, in the form www.example.com. After about two minutes, you receive a grade (from A to F) for your site and a detailed breakdown of the ﬁndings. The following table summarizes the report for a domain with settings identical to the default Apache conﬁguration on AL2023, and with a default Certbot certiﬁcate. Overall rating Certiﬁcate Protocol support Key exchange Cipher strength B 100% 95% 70% 90% Step 3: Test and harden the security conﬁguration 307 Amazon Linux 2023 User Guide Though the overview shows that the conﬁguration is mostly sound, the detailed report
al2023-ug-064	al2023-ug.pdf	64	the fully qualiﬁed domain name of your server, in the form www.example.com. After about two minutes, you receive a grade (from A to F) for your site and a detailed breakdown of the ﬁndings. The following table summarizes the report for a domain with settings identical to the default Apache conﬁguration on AL2023, and with a default Certbot certiﬁcate. Overall rating Certiﬁcate Protocol support Key exchange Cipher strength B 100% 95% 70% 90% Step 3: Test and harden the security conﬁguration 307 Amazon Linux 2023 User Guide Though the overview shows that the conﬁguration is mostly sound, the detailed report ﬂags several potential problems, listed here in order of severity: ✗ The RC4 cipher is supported for use by certain older browsers. A cipher is the mathematical core of an encryption algorithm. RC4, a fast cipher used to encrypt TLS data-streams, is known to have several serious weaknesses. Unless you have very good reasons to support legacy browsers, you should disable this. ✗ Old TLS versions are supported. The conﬁguration supports TLS 1.0 (already deprecated) and TLS 1.1 (on a path to deprecation). Only TLS 1.2 has been recommended since 2018. ✗ Forward secrecy is not fully supported. Forward secrecy is a feature of algorithms that encrypt using temporary (ephemeral) session keys derived from the private key. This means in practice that attackers cannot decrypt HTTPS data even if they possess a web server's long-term private key. To correct and future-proof the TLS conﬁguration 1. Open the conﬁguration ﬁle /etc/httpd/conf.d/ssl.conf in a text editor and comment out the following line by entering "#" at the beginning of the line. #SSLProtocol all -SSLv3 2. Add the following directive: #SSLProtocol all -SSLv3 SSLProtocol -SSLv2 -SSLv3 -TLSv1 -TLSv1.1 +TLSv1.2 This directive explicitly disables SSL versions 2 and 3, as well as TLS versions 1.0 and 1.1. The server now refuses to accept encrypted connections with clients using anything except TLS 1.2. The verbose wording in the directive conveys more clearly, to a human reader, what the server is conﬁgured to do. Note Disabling TLS versions 1.0 and 1.1 in this manner blocks a small percentage of outdated web browsers from accessing your site. Step 3: Test and harden the security conﬁguration 308 Amazon Linux 2023 User Guide To modify the list of allowed ciphers 1. In the conﬁguration ﬁle /etc/httpd/conf.d/ssl.conf, ﬁnd the section with the SSLCipherSuite directive and comment out the existing line by entering "#" at the beginning of the line. #SSLCipherSuite HIGH:MEDIUM:!aNULL:!MD5 2. Specify explicit cipher suites and a cipher order that prioritizes forward secrecy and avoids insecure ciphers. The SSLCipherSuite directive used here is based on output from the Mozilla SSL Conﬁguration Generator, which tailors a TLS conﬁguration to the speciﬁc software running on your server. First determine your Apache and OpenSSL versions by using the output from the following commands. [ec2-user ~]$ yum list installed \| grep httpd [ec2-user ~]$ yum list installed \| grep openssl For example, if the returned information is Apache 2.4.34 and OpenSSL 1.0.2, we enter this into the generator. If you choose the "modern" compatibility model, this creates an SSLCipherSuite directive that aggressively enforces security but still works for most browsers. If your software doesn't support the modern conﬁguration, you can update your software or choose the "intermediate" conﬁguration instead. SSLCipherSuite ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE- ECDSA-CHACHA20-POLY1305: ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM- SHA256: ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE- RSA-AES128-SHA256 The selected ciphers have ECDHE in their names, an abbreviation for Elliptic Curve Diﬃe- Hellman Ephemeral . The term ephemeral indicates forward secrecy. As a by-product, these ciphers do not support RC4. We recommend that you use an explicit list of ciphers instead of relying on defaults or terse directives whose content isn't visible. Copy the generated directive into /etc/httpd/conf.d/ssl.conf. Step 3: Test and harden the security conﬁguration 309 Amazon Linux 2023 Note User Guide Though shown here on several lines for readability, the directive must be on a single line when copied to /etc/httpd/conf.d/ssl.conf, with only a colon (no spaces) between cipher names. 3. Finally, uncomment the following line by removing the "#" at the beginning of the line. #SSLHonorCipherOrder on This directive forces the server to prefer high-ranking ciphers, including (in this case) those that support forward secrecy. With this directive turned on, the server tries to establish a strong secure connection before falling back to allowed ciphers with lesser security. After completing both of these procedures, save the changes to /etc/httpd/conf.d/ssl.conf and restart Apache. If you test the domain again on Qualys SSL Labs, you should see that the RC4 vulnerability and other warnings are gone and the summary looks something like the following. Overall rating Certiﬁcate Protocol support Key exchange Cipher strength A 100% 100% 90% 90% Each update to OpenSSL introduces new ciphers and removes support for old ones. Keep your EC2 AL2023 instance up-to-date, watch for security announcements from OpenSSL, and
al2023-ug-065	al2023-ug.pdf	65	tries to establish a strong secure connection before falling back to allowed ciphers with lesser security. After completing both of these procedures, save the changes to /etc/httpd/conf.d/ssl.conf and restart Apache. If you test the domain again on Qualys SSL Labs, you should see that the RC4 vulnerability and other warnings are gone and the summary looks something like the following. Overall rating Certiﬁcate Protocol support Key exchange Cipher strength A 100% 100% 90% 90% Each update to OpenSSL introduces new ciphers and removes support for old ones. Keep your EC2 AL2023 instance up-to-date, watch for security announcements from OpenSSL, and be alert to reports of new security exploits in the technical press. Troubleshoot • My Apache webserver doesn't start unless I enter a password Troubleshoot 310 Amazon Linux 2023 User Guide This is expected behavior if you installed an encrypted, password-protected, private server key. You can remove the encryption and password requirement from the key. Assuming that you have a private encrypted RSA key called custom.key in the default directory, and that the password on it is abcde12345, run the following commands on your EC2 instance to generate an unencrypted version of the key. [ec2-user ~]$ cd /etc/pki/tls/private/ [ec2-user private]$ sudo cp custom.key custom.key.bak [ec2-user private]$ sudo openssl rsa -in custom.key -passin pass:abcde12345 -out custom.key.nocrypt [ec2-user private]$ sudo mv custom.key.nocrypt custom.key [ec2-user private]$ sudo chown root:root custom.key [ec2-user private]$ sudo chmod 600 custom.key [ec2-user private]$ sudo systemctl restart httpd Apache should now start without prompting you for a password. • I get errors when I run sudo dnf install -y mod_ssl. When you are installing the required packages for SSL, you may see errors similar to the following. Error: httpd24-tools conflicts with httpd-tools-2.2.34-1.16.amzn1.x86_64 Error: httpd24 conflicts with httpd-2.2.34-1.16.amzn1.x86_64 This typically means that your EC2 instance is not running AL2023. This tutorial only supports instances freshly created from an oﬃcial AL2023 AMI. Tutorial: Host a WordPress blog on AL2023 The following procedures will help you install, conﬁgure, and secure a WordPress blog on your AL2023 instance. This tutorial is a good introduction to using Amazon EC2 in that you have full control over a web server that hosts your WordPress blog, which is not typical with a traditional hosting service. You are responsible for updating the software packages and maintaining security patches for your server. For a more automated WordPress installation that does not require direct interaction with the web server conﬁguration, the AWS CloudFormation service provides a WordPress template that Host a WordPress blog on AL2023 311 Amazon Linux 2023 User Guide can also get you started quickly. For more information, see Get started in the AWS CloudFormation User Guide. If you need a high-availability solution with a decoupled database, see Deploying a high-availability WordPress website in the AWS Elastic Beanstalk Developer Guide. Important These procedures are intended for use with AL2023. For information about other distributions, see their speciﬁc documentation. Many steps in this tutorial do not work on Ubuntu instances. For help installing WordPress on an Ubuntu instance, see WordPress in the Ubuntu documentation. You can also use CodeDeploy to accomplish this task on Amazon Linux, macOS, or Unix systems. Topics • Prerequisites • Install WordPress • Next steps • Help! My public DNS name changed and now my blog is broken Prerequisites We strongly recommend that you associate an Elastic IP address (EIP) to the instance you are using to host a WordPress blog. This prevents the public DNS address for your instance from changing and breaking your installation. If you own a domain name and you want to use it for your blog, you can update the DNS record for the domain name to point to your EIP address (for help with this, contact your domain name registrar). You can have one EIP address associated with a running instance at no charge. For more information, see Elastic IP addresses in the Amazon EC2 User Guide. The Tutorial: Install a LAMP server on AL2023 tutorial has steps for conﬁguring a security group to allow HTTP and HTTPS traﬃc, as well as several steps to ensure that ﬁle permissions are set properly for your web server. For information about adding rules to your security group, see Add rules to a security group. If you don't already have a domain name for your blog, you can register a domain name with Route 53 and associate your instance's EIP address with your domain name. For more information, see Registering domain names using Amazon Route 53 in the Amazon Route 53 Developer Guide. Prerequisites 312 Amazon Linux 2023 Install WordPress User Guide Connect to your instance, and download the WordPress installation package. For more information about connecting to your instance, see Connecting to AL2023 instances. 1. Download and install these packages using the following command. dnf install wget php-mysqlnd httpd php-fpm
al2023-ug-066	al2023-ug.pdf	66	to a security group. If you don't already have a domain name for your blog, you can register a domain name with Route 53 and associate your instance's EIP address with your domain name. For more information, see Registering domain names using Amazon Route 53 in the Amazon Route 53 Developer Guide. Prerequisites 312 Amazon Linux 2023 Install WordPress User Guide Connect to your instance, and download the WordPress installation package. For more information about connecting to your instance, see Connecting to AL2023 instances. 1. Download and install these packages using the following command. dnf install wget php-mysqlnd httpd php-fpm php-mysqli mariadb105-server php-json php php-devel -y 2. You may notice a warning displayed with similar verbiage in the output (the versions may vary over time): WARNING: A newer release of "Amazon Linux" is available. Available Versions: dnf upgrade --releasever=2023.0.20230202 Release notes: https://aws.amazon.com Version 2023.0.20230204: Run the following command to update to 2023.0.20230204: dnf upgrade --releasever=2023.0.20230204 ... etc As a best-practice we recommend keeping the OS as up-to-date as possible, but you may want to iterate through each version to ensure there are no conﬂicts in your environment. If installation of the preceding packages noted in step 1 fail, you may need to update to one of the newer releases listed, and retry. 3. Download the latest WordPress installation package with the wget command. The following command should always download the latest release. [ec2-user ~]$ wget https://wordpress.org/latest.tar.gz 4. Unzip and unarchive the installation package. The installation folder is unzipped to a folder called wordpress. Install WordPress 313 Amazon Linux 2023 User Guide [ec2-user ~]$ tar -xzf latest.tar.gz To create a database user and database for your WordPress installation Your WordPress installation needs to store information, such as blog posts and user comments, in a database. This procedure helps you create your blog's database and a user that is authorized to read and save information to it. 1. Start the database and web server. [ec2-user ~]$ sudo systemctl start mariadb httpd 2. Log in to the database server as the root user. Enter your database root password when prompted; this may be diﬀerent than your root system password, or it might even be empty if you have not secured your database server. If you have not secured your database server yet, it is important that you do so. For more information, see Step 3: Secure the database server (AL2023). [ec2-user ~]$ mysql -u root -p 3. Create a user and password for your MySQL database. Your WordPress installation uses these values to communicate with your MySQL database. Enter the following command, substituting a unique user name and password. CREATE USER 'wordpress-user'@'localhost' IDENTIFIED BY 'your_strong_password'; Make sure that you create a strong password for your user. Do not use the single quote character ( ' ) in your password, because this will break the preceding command. Do not reuse an existing password, and make sure to store this password in a safe place. 4. Create your database. Give your database a descriptive, meaningful name, such as wordpress-db. Note The punctuation marks surrounding the database name in the command below are called backticks. The backtick (`) key is usually located above the Tab key on Install WordPress 314 Amazon Linux 2023 User Guide a standard keyboard. Backticks are not always required, but they allow you to use otherwise illegal characters, such as hyphens, in database names. CREATE DATABASE `wordpress-db`; 5. Grant full privileges for your database to the WordPress user that you created earlier. GRANT ALL PRIVILEGES ON `wordpress-db`.* TO "wordpress-user"@"localhost"; 6. Flush the database privileges to pick up all of your changes. FLUSH PRIVILEGES; 7. Exit the mysql client. exit To create and edit the wp-conﬁg.php ﬁle The WordPress installation folder contains a sample conﬁguration ﬁle called wp-config- sample.php. In this procedure, you copy this ﬁle and edit it to ﬁt your speciﬁc conﬁguration. 1. Copy the wp-config-sample.php ﬁle to a ﬁle called wp-config.php. This creates a new conﬁguration ﬁle and keeps the original sample ﬁle intact as a backup. [ec2-user ~]$ cp wordpress/wp-config-sample.php wordpress/wp-config.php 2. Edit the wp-config.php ﬁle with your favorite text editor (such as nano or vim) and enter values for your installation. If you do not have a favorite text editor, nano is suitable for beginners. [ec2-user ~]$ nano wordpress/wp-config.php a. Find the line that deﬁnes DB_NAME and change database_name_here to the database name that you created in Step 4 of To create a database user and database for your WordPress installation. Install WordPress 315 Amazon Linux 2023 User Guide define('DB_NAME', 'wordpress-db'); b. Find the line that deﬁnes DB_USER and change username_here to the database user that you created in Step 3 of To create a database user and database for your WordPress installation. define('DB_USER', 'wordpress-user'); c. Find the line that deﬁnes DB_PASSWORD and change password_here to the strong
al2023-ug-067	al2023-ug.pdf	67	text editor, nano is suitable for beginners. [ec2-user ~]$ nano wordpress/wp-config.php a. Find the line that deﬁnes DB_NAME and change database_name_here to the database name that you created in Step 4 of To create a database user and database for your WordPress installation. Install WordPress 315 Amazon Linux 2023 User Guide define('DB_NAME', 'wordpress-db'); b. Find the line that deﬁnes DB_USER and change username_here to the database user that you created in Step 3 of To create a database user and database for your WordPress installation. define('DB_USER', 'wordpress-user'); c. Find the line that deﬁnes DB_PASSWORD and change password_here to the strong password that you created in Step 3 of To create a database user and database for your WordPress installation. define('DB_PASSWORD', 'your_strong_password'); d. Find the section called Authentication Unique Keys and Salts. These KEY and SALT values provide a layer of encryption to the browser cookies that WordPress users store on their local machines. Basically, adding long, random values here makes your site more secure. Visit https://api.wordpress.org/secret-key/1.1/salt/ to randomly generate a set of key values that you can copy and paste into your wp-config.php ﬁle. To paste text into a PuTTY terminal, place the cursor where you want to paste the text and right-click your mouse inside the PuTTY terminal. For more information about security keys, go to https://wordpress.org/support/article/ editing-wp-conﬁg-php/#security-keys. Note The values below are for example purposes only; do not use these values for your installation. define('AUTH_KEY', ' #U$$+[RXN8:b^-L 0(WU_+ c+WFkI~c]o]-bHw+)/ Aj[wTwSiZ<Qb[mghEXcRh-'); define('SECURE_AUTH_KEY', 'Zsz._P=l/\|y.Lq)XjlkwS1y5NJ76E6EJ.AV0pCKZZB,~r ? 6OP$eJT@;+(ndLg'); define('LOGGED_IN_KEY', 'ju}qwre3V+8f_zOWf?{LlGsQ]Ye@2Jh^,8x>)Y \|;(^[Iw]Pi +LG#A4R?7N`YB3'); Install WordPress 316 Amazon Linux 2023 User Guide define('NONCE_KEY', 'P(g62HeZxEes\|LnI^i=H,[XwK9I&[2s\|:?0N}VJM%?;v2v]v+; +^9eXUahg@::Cj'); define('AUTH_SALT', 'C$DpB4Hj[JK:?{ql`sRVa:{:7yShy(9A@5wg+`JJVb1fk%_- BxM4(qc[Qg%JT!h'); define('SECURE_AUTH_SALT', 'd!uRu#}+q#{f$Z?Z9uFPG.${+S{n~1M&%@~gL>U>NV<zpD-@2- Es7Q1O-bp28EKv'); define('LOGGED_IN_SALT', ';j{00PowZf)kVD+FVLn-~ >.\|Y%Ug4#I^LVd9QeZ^&XmK\| e(76miC+&W&+^0P/'); define('NONCE_SALT', '-97rV/cgxLmp?Zy4zUU4r99QQ_rGs2LTd%P;\| _e1tS)8_B/,.6[=UK<J_y9?JWG'); e. Save the ﬁle and exit your text editor. To install your WordPress ﬁles under the Apache document root • Now that you've unzipped the installation folder, created a MySQL database and user, and customized the WordPress conﬁguration ﬁle, you are ready to copy your installation ﬁles to your web server document root so you can run the installation script that completes your installation. The location of these ﬁles depends on whether you want your WordPress blog to be available at the actual root of your web server (for example, my.public.dns.amazonaws.com) or in a subdirectory or folder under the root (for example, my.public.dns.amazonaws.com/blog). • If you want WordPress to run at your document root, copy the contents of the wordpress installation directory (but not the directory itself) as follows: [ec2-user ~]$ cp -r wordpress/ /var/www/html/ • If you want WordPress to run in an alternative directory under the document root, ﬁrst create that directory, and then copy the ﬁles to it. In this example, WordPress will run from the directory blog: [ec2-user ~]$ mkdir /var/www/html/blog [ec2-user ~]$ cp -r wordpress/* /var/www/html/blog/ Important For security purposes, if you are not moving on to the next procedure immediately, stop the Apache web server (httpd) now. After you move your installation under the Apache Install WordPress 317 Amazon Linux 2023 User Guide document root, the WordPress installation script is unprotected and an attacker could gain access to your blog if the Apache web server were running. To stop the Apache web server, enter the command sudo service httpd stop. If you are moving on to the next procedure, you do not need to stop the Apache web server. To allow WordPress to use permalinks WordPress permalinks need to use Apache .htaccess ﬁles to work properly, but this is not enabled by default on Amazon Linux. Use this procedure to allow all overrides in the Apache document root. 1. Open the httpd.conf ﬁle with your favorite text editor (such as nano or vim). If you do not have a favorite text editor, nano is suitable for beginners. [ec2-user ~]$ sudo vim /etc/httpd/conf/httpd.conf 2. Find the section that starts with <Directory "/var/www/html">. <Directory "/var/www/html"> # # Possible values for the Options directive are "None", "All", # or any combination of: # Indexes Includes FollowSymLinks SymLinksifOwnerMatch ExecCGI MultiViews # # Note that "MultiViews" must be named explicitly --- "Options All" # doesn't give it to you. # # The Options directive is both complicated and important. Please see # http://httpd.apache.org/docs/2.4/mod/core.html#options # for more information. # Options Indexes FollowSymLinks # # AllowOverride controls what directives may be placed in .htaccess files. # It can be "All", "None", or any combination of the keywords: # Options FileInfo AuthConfig Limit # AllowOverride None # Install WordPress 318 Amazon Linux 2023 User Guide # Controls who can get stuff from this server. # Require all granted </Directory> 3. Change the AllowOverride None line in the above section to read AllowOverride All. Note There are multiple AllowOverride lines in this ﬁle; be sure you change the line in the <Directory "/var/www/html"> section. AllowOverride All 4. Save the ﬁle and exit your text editor. To install the PHP
al2023-ug-068	al2023-ug.pdf	68	what directives may be placed in .htaccess files. # It can be "All", "None", or any combination of the keywords: # Options FileInfo AuthConfig Limit # AllowOverride None # Install WordPress 318 Amazon Linux 2023 User Guide # Controls who can get stuff from this server. # Require all granted </Directory> 3. Change the AllowOverride None line in the above section to read AllowOverride All. Note There are multiple AllowOverride lines in this ﬁle; be sure you change the line in the <Directory "/var/www/html"> section. AllowOverride All 4. Save the ﬁle and exit your text editor. To install the PHP graphics drawing library on AL2023 The GD library for PHP enables you to modify images. Install this library if you need to crop the header image for your blog. The version of phpMyAdmin that you install might require a speciﬁc minimum version of this library (for example, version 8.1). Use the following command to install the PHP graphics drawing library on AL2023. For example, if you installed php8.1 from source as part of installing the LAMP stack, this command installs version 8.1 of the PHP graphics drawing library. [ec2-user ~]$ sudo dnf install php-gd To verify the installed version, use the following command: [ec2-user ~]$ sudo dnf list installed \| grep php-gd The following is example output: php-gd.x86_64 8.1.30-1.amzn2 @amazonlinux To install the PHP graphics drawing library on the Amazon Linux AMI Install WordPress 319 Amazon Linux 2023 User Guide The GD library for PHP enables you to modify images. Install this library if you need to crop the header image for your blog. The version of phpMyAdmin that you install might require a speciﬁc minimum version of this library (for example, version 8.1). To verify which versions are available, use the following command: [ec2-user ~]$ dnf list \| grep php The following is example lines from the output for the PHP graphics drawing library (version 8.1): php8.1.aarch64 8.1.7-1.amzn2023.0.1 @amazonlinux php8.1-cli.aarch64 8.1.7-1.amzn2023.0.1 @amazonlinux php8.1-common.aarch64 8.1.7-1.amzn2023.0.1 @amazonlinux php8.1-devel.aarch64 8.1.7-1.amzn2023.0.1 @amazonlinux php8.1-fpm.aarch64 8.1.7-1.amzn2023.0.1 @amazonlinux php8.1-gd.aarch64 8.1.7-1.amzn2023.0.1 @amazonlinux Use the following command to install a speciﬁc version of the PHP graphics drawing library (for example, version php8.1) on the Amazon Linux AMI: [ec2-user ~]$ sudo dnf install -y php8.1-gd To ﬁx ﬁle permissions for the Apache web server Some of the available features in WordPress require write access to the Apache document root (such as uploading media though the Administration screens). If you have not already done so, apply the following group memberships and permissions (as described in greater detail in the LAMP web server tutorial). 1. Grant ﬁle ownership of /var/www and its contents to the apache user. [ec2-user ~]$ sudo chown -R apache /var/www 2. Grant group ownership of /var/www and its contents to the apache group. Install WordPress 320 Amazon Linux 2023 User Guide [ec2-user ~]$ sudo chgrp -R apache /var/www 3. Change the directory permissions of /var/www and its subdirectories to add group write permissions and to set the group ID on future subdirectories. [ec2-user ~]$ sudo chmod 2775 /var/www [ec2-user ~]$ find /var/www -type d -exec sudo chmod 2775 {} \; 4. Recursively change the ﬁle permissions of /var/www and its subdirectories. [ec2-user ~]$ find /var/www -type f -exec sudo chmod 0644 {} \; Note If you intend to also use WordPress as an FTP server, you'll need more permissive Group settings here. Please review the recommended steps and security settings in WordPress to accomplish this. 5. Restart the Apache web server to pick up the new group and permissions. [ec2-user ~]$ sudo systemctl restart httpd To run the WordPress installation script with AL2023 You are ready to install WordPress. The commands that you use depend on the operating system. The commands in this procedure are for use with AL2023. Use the procedure that follows this one with AL2023 AMI. 1. Use the systemctl command to ensure that the httpd and database services start at every system boot. [ec2-user ~]$ sudo systemctl enable httpd && sudo systemctl enable mariadb 2. Verify that the database server is running. [ec2-user ~]$ sudo systemctl status mariadb Install WordPress 321 Amazon Linux 2023 User Guide If the database service is not running, start it. [ec2-user ~]$ sudo systemctl start mariadb 3. Verify that your Apache web server (httpd) is running. [ec2-user ~]$ sudo systemctl status httpd If the httpd service is not running, start it. [ec2-user ~]$ sudo systemctl start httpd 4. In a web browser, type the URL of your WordPress blog (either the public DNS address for your instance, or that address followed by the blog folder). You should see the WordPress installation script. Provide the information required by the WordPress installation. Choose Install WordPress to complete the installation. For more information, see Step 5: Run the Install Script on the WordPress website. To run the WordPress installation script with
al2023-ug-069	al2023-ug.pdf	69	that your Apache web server (httpd) is running. [ec2-user ~]$ sudo systemctl status httpd If the httpd service is not running, start it. [ec2-user ~]$ sudo systemctl start httpd 4. In a web browser, type the URL of your WordPress blog (either the public DNS address for your instance, or that address followed by the blog folder). You should see the WordPress installation script. Provide the information required by the WordPress installation. Choose Install WordPress to complete the installation. For more information, see Step 5: Run the Install Script on the WordPress website. To run the WordPress installation script with AL2023 AMI 1. Use the chkconﬁg command to ensure that the httpd and database services start at every system boot. [ec2-user ~]$ sudo chkconfig httpd on && sudo chkconfig mariadb on 2. Verify that the database server is running. [ec2-user ~]$ sudo service mariadb status If the database service is not running, start it. [ec2-user ~]$ sudo service mariadb start 3. Verify that your Apache web server (httpd) is running. [ec2-user ~]$ sudo service httpd status If the httpd service is not running, start it. Install WordPress 322 Amazon Linux 2023 User Guide [ec2-user ~]$ sudo service httpd start 4. In a web browser, type the URL of your WordPress blog (either the public DNS address for your instance, or that address followed by the blog folder). You should see the WordPress installation script. Provide the information required by the WordPress installation. Choose Install WordPress to complete the installation. For more information, see Step 5: Run the Install Script on the WordPress website. Next steps After you have tested your WordPress blog, consider updating its conﬁguration. Use a custom domain name If you have a domain name associated with your EC2 instance's EIP address, you can conﬁgure your blog to use that name instead of the EC2 public DNS address. For more information, see Changing The Site URL on the WordPress website. Conﬁgure your blog You can conﬁgure your blog to use diﬀerent themes and plugins to oﬀer a more personalized experience for your readers. However, sometimes the installation process can backﬁre, causing you to lose your entire blog. We strongly recommend that you create a backup Amazon Machine Image (AMI) of your instance before attempting to install any themes or plugins so you can restore your blog if anything goes wrong during installation. For more information, see Create your own AMI in the Amazon EC2 User Guide. Increase capacity If your WordPress blog becomes popular and you need more compute power or storage, consider the following steps: • Expand the storage space on your instance. For more information, see Amazon EBS Elastic Volumes. • Move your MySQL database to Amazon RDS to take advantage of the service's ability to scale easily. Improve network performance of your internet traﬃc Next steps 323 Amazon Linux 2023 User Guide If you expect your blog to drive traﬃc from users located around the world, consider AWS Global Accelerator. Global Accelerator helps you achieve lower latency by improving internet traﬃc performance between your users’ client devices and your WordPress application running on AWS. Global Accelerator uses the AWS global network to direct traﬃc to a healthy application endpoint in the AWS Region that is closest to the client. Learn more about WordPress The following links contain more information about WordPress. • For information about WordPress, see the WordPress Codex help documentation at Codex. • For more information about troubleshooting your installation, go to Common installatino problems. • For information about making your WordPress blog more secure, go to Hardening WordPress. • For information about keeping your WordPress blog up-to-date, go to Updating WordPress. Help! My public DNS name changed and now my blog is broken Your WordPress installation is automatically conﬁgured using the public DNS address for your EC2 instance. If you stop and restart the instance, the public DNS address changes (unless it is associated with an Elastic IP address) and your blog will not work anymore because it references resources at an address that no longer exists (or is assigned to another EC2 instance). A more detailed description of the problem and several possible solutions are outlined in https:// wordpress.org/support/article/changing-the-site-url/. If this has happened to your WordPress installation, you may be able to recover your blog with the procedure below, which uses the wp-cli command line interface for WordPress. To change your WordPress site URL with the wp-cli 1. Connect to your EC2 instance with SSH. 2. Note the old site URL and the new site URL for your instance. The old site URL is likely the public DNS name for your EC2 instance when you installed WordPress. The new site URL is the current public DNS name for your EC2 instance. If you are not sure of your old site URL,
al2023-ug-070	al2023-ug.pdf	70	has happened to your WordPress installation, you may be able to recover your blog with the procedure below, which uses the wp-cli command line interface for WordPress. To change your WordPress site URL with the wp-cli 1. Connect to your EC2 instance with SSH. 2. Note the old site URL and the new site URL for your instance. The old site URL is likely the public DNS name for your EC2 instance when you installed WordPress. The new site URL is the current public DNS name for your EC2 instance. If you are not sure of your old site URL, you can use curl to ﬁnd it with the following command. [ec2-user ~]$ curl localhost \| grep wp-content Help! My public DNS name changed and now my blog is broken 324 Amazon Linux 2023 User Guide You should see references to your old public DNS name in the output, which will look like this (old site URL in red): <script type='text/javascript' src='http://ec2-52-8-139-223.us- west-1.compute.amazonaws.com/wp-content/themes/twentyfifteen/js/functions.js? ver=20150330'></script> 3. Download the wp-cli with the following command. [ec2-user ~]$ curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/ phar/wp-cli.phar 4. Search and replace the old site URL in your WordPress installation with the following command. Substitute the old and new site URLs for your EC2 instance and the path to your WordPress installation (usually /var/www/html or /var/www/html/blog). [ec2-user ~]$ php wp-cli.phar search-replace 'old_site_url' 'new_site_url' --path=/ path/to/wordpress/installation --skip-columns=guid 5. In a web browser, enter the new site URL of your WordPress blog to verify that the site is working properly again. If it is not, see Changing the site URL and Common installation problems for more information. Tutorial: Redis 6 to Valkey Transition on AL2023 The following documentation describes key aspects of the transition from Redis 6 to Valkey on AL2023. Support timeline for Redis 6 Redis 6 reaches its End of Life (EOL) on August 31, 2025. After this date, Redis 6 will no longer receive updates or security patches from the Redis project. We strongly recommend users migrate to Valkey before August 2025 to ensure continued support and security updates. For more information on Redis version support timelines, see Redis End-Of-Life Schedule documentation. Redis 6 to Valkey Transition on AL2023 325 Amazon Linux 2023 Introduction to Valkey User Guide Valkey is an open-source fork of Redis 7, maintained by The Linux Foundation. It's fully compatible with Redis Open Source Software (OSS) versions 2.x through 7.2.x. Valkey maintains the familiar Redis API and functionality while oﬀering several enhancements: • Enhanced performance through multi-threading. • Improved memory eﬃciency, especially in cluster mode. • Dual-channel replication for better data consistency. Migration plan and timeline Users are strongly encouraged to migrate from Redis 6 to Valkey before August 31, 2025, when Redis 6 reaches its End of Life (EOL). This migration requires manual intervention and is not automatic. Amazon Linux recommends this migration to ensure continued functionality, support, and security updates for your Redis-dependent applications. Migration options and steps We propose three migration paths to Valkey based on your deployment requirements and operational needs. Option 1: New Instance Installation For new deployments or when data migration is not needed: 1. Install Valkey: [ec2-user ~]$ sudo dnf install valkey 2. Start Valkey: [ec2-user ~]$ sudo systemctl start valkey 3. (Optional) Enable Valkey on boot: [ec2-user ~]$ sudo systemctl enable valkey Introduction to Valkey 326 User Guide Amazon Linux 2023 4. Verify the installation: [ec2-user ~]$ valkey-cli info server [ec2-user ~]$ valkey-cli ping Option 2: In-Place Replacement For existing instances where data persistence is not required: 1. Stop Redis 6: [ec2-user ~]$ sudo systemctl stop redis6 2. Install Valkey: [ec2-user ~]$ sudo dnf install valkey 3. (Optional) Use Redis 6 conﬁguration in Valkey: [ec2-user ~]$ sudo cp /etc/redis6/redis6.conf /etc/valkey/valkey.conf [ec2-user ~]$ sudo cp /etc/valkey/valkey.conf /etc/valkey/valkey.conf.backup [ec2-user ~]$ sudo chown valkey:root /etc/valkey/valkey.conf [ec2-user ~]$ sudo sed -i 's\|^dir\s.\|dir /var/lib/valkey\|g' /etc/valkey/ valkey.conf 4. (Optional) Use Redis 6 sentinel conﬁguration ﬁle in Valkey: [ec2-user ~]$ sudo cp /etc/redis6/sentinel.conf /etc/valkey/sentinel.conf [ec2-user ~]$ sudo chown valkey:root /etc/valkey/sentinel.conf 5. Start Valkey: [ec2-user ~]$ sudo systemctl start valkey 6. (Optional) Enable Valkey on boot: [ec2-user ~]$ sudo systemctl enable valkey 7. Verify Valkey installation: [ec2-user ~]$ valkey-cli info server Migration options and steps 327 Amazon Linux 2023 User Guide [ec2-user ~]$ valkey-cli ping 8. Remove Redis 6: [ec2-user ~]$ sudo dnf remove redis6 Option 3: Data Migration This option allows you to run both Redis 6 and Valkey concurrently. 1. Install Valkey without removing Redis 6: [ec2-user ~]$ sudo dnf install valkey 2. (Optional) Use Redis 6 conﬁguration in Valkey: [ec2-user ~]$ sudo cp /etc/redis6/redis6.conf /etc/valkey/valkey.conf [ec2-user ~]$ sudo cp /etc/valkey/valkey.conf /etc/valkey/valkey.conf.backup [ec2-user ~]$ sudo chown valkey:root /etc/valkey/valkey.conf [ec2-user ~]$ sudo sed -i 's\|^dir\s.\|dir /var/lib/valkey\|g' /etc/valkey/ valkey.conf 3. (Optional) Use Redis 6 sentinel conﬁguration ﬁle in Valkey: [ec2-user ~]$ sudo cp /etc/redis6/sentinel.conf /etc/valkey/sentinel.conf [ec2-user ~]$ sudo chown valkey:root /etc/valkey/sentinel.conf 4. Modify Valkey conﬁguration:
al2023-ug-071	al2023-ug.pdf	71	8. Remove Redis 6: [ec2-user ~]$ sudo dnf remove redis6 Option 3: Data Migration This option allows you to run both Redis 6 and Valkey concurrently. 1. Install Valkey without removing Redis 6: [ec2-user ~]$ sudo dnf install valkey 2. (Optional) Use Redis 6 conﬁguration in Valkey: [ec2-user ~]$ sudo cp /etc/redis6/redis6.conf /etc/valkey/valkey.conf [ec2-user ~]$ sudo cp /etc/valkey/valkey.conf /etc/valkey/valkey.conf.backup [ec2-user ~]$ sudo chown valkey:root /etc/valkey/valkey.conf [ec2-user ~]$ sudo sed -i 's\|^dir\s.*\|dir /var/lib/valkey\|g' /etc/valkey/ valkey.conf 3. (Optional) Use Redis 6 sentinel conﬁguration ﬁle in Valkey: [ec2-user ~]$ sudo cp /etc/redis6/sentinel.conf /etc/valkey/sentinel.conf [ec2-user ~]$ sudo chown valkey:root /etc/valkey/sentinel.conf 4. Modify Valkey conﬁguration: Edit /etc/valkey/valkey.conf and set the 'port' directive to a diﬀerent value (for example, 6380) to avoid conﬂicts with Redis 6. 5. Start Valkey: [ec2-user ~]$ sudo systemctl start valkey 6. (Optional) Enable Valkey on boot: [ec2-user ~]$ sudo systemctl enable valkey 7. Verify Valkey installation: Migration options and steps 328 Amazon Linux 2023 User Guide [ec2-user ~]$ valkey-cli -p port info server [ec2-user ~]$ valkey-cli -p port ping Note Replace port with the conﬁgured port number. 8. Migrate data: You can now migrate data from Redis 6 to Valkey using replication or manual data transfer methods. 9. Update application conﬁgurations: Gradually update your applications to use the Valkey port. 10. Remove Redis 6: Once all data and applications have been migrated, you can stop and remove Redis 6. [ec2-user ~]$ sudo systemctl stop redis6 [ec2-user ~]$ sudo dnf remove redis6 Note It is strongly recommended to validate the migration process in a test environment before implementing changes in production systems. Related topics For more information about Valkey: • Valkey: https://valkey.io/ • Valkey migration: https://valkey.io/topics/migration/ Related topics 329 Amazon Linux 2023 User Guide Tutorial: Install the GNOME desktop environment on AL2023 The GNOME desktop environment is available as an optional graphical user interface for AL2023 as of release 2023.7 or later. The following procedures help you install the GNOME desktop environment on your AL2023 instance. You can use this graphical interface to interact with your Linux system using a familiar desktop environment instead of just the command line interface. Contents • Prerequisites • Installation • Related topics Prerequisites • The desktop environment requires at least 2.4 GB of memory. Therefore, an instance of type t2.medium or better is recommended to ensure adequate performance. Examples of instance types with insuﬃcient memory include t2.nano, t2.micro, and t2.small. This restriction also applies to t3 and t4 instances of this size, as well as any other instance type that doesn't meet the memory requirement. • This tutorial assumes that you have already launched an instance using AL2023 running release 2023.7 or later. For more information, see the AL2023 on Amazon EC2 and Updating AL2023 pages. Installation • Install the GNOME desktop environment and related packages. [ec2-user ~]$ sudo dnf groupinstall "Desktop" -y Install GNOME on AL2023 330 Amazon Linux 2023 Note User Guide To access the graphical desktop environment, you'll need to install and conﬁgure additional software such as Amazon DCV or VNC. These tools allow you to connect to and interact with the graphical user interface over the network. Related topics For more information about the graphical desktop environment, see the following documentation: • What Is Amazon DCV? in the Amazon DCV Administrator Guide • Tutorial: Conﬁgure TigerVNC server on AL2023 Tutorial: Conﬁgure TigerVNC server on AL2023 The following procedures help you set up VNC server on your AL2023 instance. VNC allows you to remotely access and interact with the graphical desktop environment over a secure network connection. Contents • Prerequisites • Step 1: Installation • Step 2: Conﬁguration • Step 3: Connect using a VNC client • (Optional) Start service at boot • (Optional) Disable the idle lockscreen • Related topics Prerequisites • This tutorial assumes you have already installed the GNOME desktop environment on your AL2023 instance. For more information, see the Tutorial: Install the GNOME desktop environment on AL2023 page. Related topics 331 Amazon Linux 2023 User Guide • This tutorial uses SSH port forwarding to access the VNC server. For more information about setting up your key pair, See Connect to your Linux instance using SSH in the Amazon EC2 User Guide. • The following procedure does not guide you through the process of installing a VNC client. You must have a VNC client installed on your local machine to be able to connect to and interact with the desktop environment. Step 1: Installation 1. Connect to your instance. For more information, see Connecting to AL2023 instances. 2. Install the TigerVNC server package for AL2023. The -y option installs the package without asking for conﬁrmation. If you would like to examine the package before installing, you can omit this option. [ec2-user ~]$ sudo dnf install -y tigervnc-server Step 2: Conﬁguration 1. Ensure the user has conﬁgured a VNC password. [ec2-user
al2023-ug-072	al2023-ug.pdf	72	through the process of installing a VNC client. You must have a VNC client installed on your local machine to be able to connect to and interact with the desktop environment. Step 1: Installation 1. Connect to your instance. For more information, see Connecting to AL2023 instances. 2. Install the TigerVNC server package for AL2023. The -y option installs the package without asking for conﬁrmation. If you would like to examine the package before installing, you can omit this option. [ec2-user ~]$ sudo dnf install -y tigervnc-server Step 2: Conﬁguration 1. Ensure the user has conﬁgured a VNC password. [ec2-user ~]$ vncpasswd 2. Assign a display number to the user. [ec2-user ~]$ sudo vi /etc/tigervnc/vncserver.users Add the following conﬁguration: :1=ec2-user Note You can assign any display number to the user. We are using display :1 for the sake of this example. Step 1: Installation 332 Amazon Linux 2023 User Guide 3. Edit the VNC server conﬁguration ﬁle. [ec2-user ~]$ sudo vi /etc/tigervnc/vncserver-config-defaults Add the following conﬁguration: session=gnome securitytypes=vncauth,tlsvnc geometry=1920x1080 localhost alwaysshared Note You can change the resolution of the display using the geometry parameter. We are using 1920x1080 for the sake of this example. 4. Start the VNC server. This process needs to be repeated every time you restart your instace. If you would like to automate the process of starting this service, see the optional section below. [ec2-user ~]$ sudo systemctl start vncserver@:1 Important When starting the vncserver service, the part after the @ must match the display number set for the user in the /etc/tigervnc/vncserver.users ﬁle. After performing this step, you may create the SSH tunnel from your local machine and connect using your VNC client. Step 3: Connect using a VNC client The VNC server exposes a TCP socket for client connections. While you could expose the VNC port directly through your security group, this tutorial demonstrates using SSH tunneling as a more secure approach by encrypting the connection between your local machine and the EC2 instance. Once connected through the tunnel, you'll authenticate to the VNC server using the password Step 3: Connect using a VNC client 333 Amazon Linux 2023 User Guide you conﬁgured in the previous step. For more information about security groups, see Change the security groups for your Amazon EC2 instance in the Amazon EC2 User Guide. 1. Create an SSH tunnel from your local machine. $ ssh -i <keypair> -L 5901:localhost:5901 ec2-user@<address> Note Replace <keypair> with the path to your SSH key and <address> with your instance's public IP or DNS name. The port changes based on the display number that was used to start the vncserver. For example, display :1 uses port 5901, display :2 uses port 5902, etc. 2. Use your VNC client to connect to localhost:5901 or 127.0.0.1:5901 with the previously set VNC password. Important Keep the SSH tunnel open while using VNC. If the SSH tunnel isn't open, you will not be able to use your VNC client to view and interact with the desktop environment. (Optional) Start service at boot If you plan to use VNC regularly, you may want to conﬁgure the VNC server to start automatically when your instance boots. This eliminates the need to manually start the VNC server each time you restart your instance. This conﬁguration ensures that your graphical desktop environment is ready and accessible as soon as your instance completes its startup process. • Conﬁgure the service to start at boot. [ec2-user ~]$ sudo systemctl enable vncserver@:1 Important When enabling the vncserver service, the part after the @ must match the display number set for the user in the /etc/tigervnc/vncserver.users ﬁle. (Optional) Start service at boot 334 Amazon Linux 2023 User Guide Additionally, you can pass the --now argument after enable to start the service immediately. After performing this step, you will no longer need to start vncserver every time you reboot your instance. (Optional) Disable the idle lockscreen • Set the idle delay to zero in order to disable the lockscreen when the user has been inactive for a longer period of time. [ec2-user ~]$ gsettings set org.gnome.desktop.session idle-delay 0 Related topics For more information about the graphical desktop environment, see the following documentation: • Tutorial: Install the GNOME desktop environment on AL2023 • What Is Amazon DCV? in the Amazon DCV Administrator Guide (Optional) Disable the idle lockscreen 335 Amazon Linux 2023 User Guide Using Amazon Linux 2023 outside of Amazon EC2 The Amazon Linux 2023 container images can be run in compatible container runtime environments. For more information on how to use Amazon Linux 2023 inside a container, see AL2023 in containers. Amazon Linux 2023 (AL2023) can also be run as a virtualized guest outside of directly being run on Amazon EC2. There are currently KVM (qcow2), VMware (OVA), and Hyper-V (vhdx) images available. Note The conﬁguration
al2023-ug-073	al2023-ug.pdf	73	desktop environment on AL2023 • What Is Amazon DCV? in the Amazon DCV Administrator Guide (Optional) Disable the idle lockscreen 335 Amazon Linux 2023 User Guide Using Amazon Linux 2023 outside of Amazon EC2 The Amazon Linux 2023 container images can be run in compatible container runtime environments. For more information on how to use Amazon Linux 2023 inside a container, see AL2023 in containers. Amazon Linux 2023 (AL2023) can also be run as a virtualized guest outside of directly being run on Amazon EC2. There are currently KVM (qcow2), VMware (OVA), and Hyper-V (vhdx) images available. Note The conﬁguration of Amazon Linux 2023 images diﬀers from Amazon Linux 2. If you are coming from Running Amazon Linux 2 as a virtual machine on premises you will need to adapt your conﬁguration to be compatible with AL2023. Download Amazon Linux 2023 images for use with KVM, VMware, and Hyper-V Amazon Linux 2023 disk images for use with KVM, VMware, and Hyper-V can be downloaded from cdn.amazonlinux.com. Supported conﬁgurations of Amazon Linux 2023 for use in non- Amazon EC2 virtualized environments This section covers the requirements for running Amazon Linux 2023 in non-Amazon EC2 virtualized environments such as on KVM, VMware, or and Hyper-V. The base AL2023 system requirements apply to all non-Amazon EC2 virtualized environments. A list of supported device models is detailed for each hypervisor environment in the following topics. KVM, VMware, and Hyper-V provide many conﬁguration options, and care needs to be taken in order to conﬁgure them for your security, performance, and reliability needs. For more information, check the documentation provided by your hypervisor. Download AL2023 VM Images 336 Amazon Linux 2023 Topics • Requirements for running AL2023 on KVM • Requirements for running AL2023 on VMware • Requirements for running Amazon Linux 2023 on Hyper-V Requirements for running AL2023 on KVM User Guide This section describes the requirements for running AL2023 on KVM. The KVM images of AL2023 are available for both aarch64 and x86-64 architectures. These requirements are in addition to the base AL2023 system requirements for the KVM images. Topics • KVM host requirements for running AL2023 on KVM • Device support for AL2023 on KVM • Boot mode (UEFI and BIOS) support for AL2023 on KVM • Limitations running AL2023 on KVM KVM host requirements for running AL2023 on KVM The KVM images are currently qualiﬁed on a host running Ubuntu 22.04.3 LTS with qemu version 6.2+dfsg-2ubuntu6.15, provided by this Ubuntu version, using a q35 machine type for x86-64 and a virt machine type for aarch64. Device support for AL2023 on KVM The qemu device models tested for use with AL2023 KVM images (both aarch64 and x86-64) are: • virtio-blk (virtio block device) • virtio-scsi (virtio SCSI controller with disk device) • virtio-net (virtio network device) • ahci (for use with the virtual CD-ROM drive) • usb-storage (over xhci) KVM Requirements 337 Amazon Linux 2023 User Guide Additional qemu device models enabled in AL2023 KVM image qualiﬁcation, but not heavily exercised are: • VGA (qemu VGA) on x86-64 only • virtio-rng (virtual random number generator) • legacy AT keyboard and PS/2 mouse devices • legacy serial device Boot mode (UEFI and BIOS) support for AL2023 on KVM The x86-64 image is tested with both legacy BIOS and UEFI boot modes. The aarch64 images are tested with UEFI boot mode. Note By default, when using UEFI boot mode, some virtual machine managers will provision the VM with Microsoft Secure Boot keys which enables Secure Boot. This conﬁguration will not boot AL2023. Because the AL2023 boot loader isn’t signed by Microsoft, the VM must be provisioned either without UEFI keys, or with the AL2023 keys for Secure Boot. Important Secure Boot support for KVMimages has not been validated yet. Limitations running AL2023 on KVM There are some known limitations in running AL2023 on KVM. Note Code implementing some of the listed unsupported functionality might exist in AL2023 and function correctly. The list of unsupported functionality exists so that you can make informed decisions about what to rely upon working today, and what the Amazon Linux team will qualify as working as part of future updates. KVM Requirements 338 Amazon Linux 2023 User Guide Known Limitations with running AL2023 on KVM • The KVM guest agent is not currently packaged or supported. • Hot plugging and unplugging CPU, memory, or any other device type is not supported. • VM hibernation is not supported. • VM migration is not supported. • Passthrough of any device such as through PCI Passthrough, or USB Passthrough is not supported. Requirements for running AL2023 on VMware This section describes the requirements for running AL2023 on VMware. The VMware images of AL2023 are available for only the x86-64 architecture. VMware images for aarch64 are not available or supported. These requirements are in
al2023-ug-074	al2023-ug.pdf	74	with running AL2023 on KVM • The KVM guest agent is not currently packaged or supported. • Hot plugging and unplugging CPU, memory, or any other device type is not supported. • VM hibernation is not supported. • VM migration is not supported. • Passthrough of any device such as through PCI Passthrough, or USB Passthrough is not supported. Requirements for running AL2023 on VMware This section describes the requirements for running AL2023 on VMware. The VMware images of AL2023 are available for only the x86-64 architecture. VMware images for aarch64 are not available or supported. These requirements are in addition to the base AL2023 system requirements for the VMware images. Topics • VMware host requirements for running AL2023 on VMware • Device support for AL2023 on VMware • Boot mode (UEFI and BIOS) support for AL2023 on VMware • Limitations running AL2023 on VMware VMware host requirements for running AL2023 on VMware The AL2023 VMware OVA images are currently qualiﬁed on the following: • VMware Workstation 17.5.0 running on hosts using an Intel(R) Xeon(R) Platinum 8124M processor • VMware vSphere 8.0 using an Intel(R) Xeon(R) Platinum 8275CL processor The AL2023 VMware OVA images specify a Machine Hardware Version of 13. VMware Machine Hardware Version 13 is supported by: • ESXi 6.5 or later VMware Requirements 339 Amazon Linux 2023 • VMware Workstation 14 or later Device support for AL2023 on VMware User Guide The following VMware device models were tested for use with AL2023 VMware OVA images (x86-64 only): • vmw_pvscsi (VMware paravirtualized SCSI controller) • vmxnet3 (VMware paravirtualized network device) • ata_piix (legacy IDE for use with the virtual CD-ROM drive only) Additional VMware device models enabled in AL2023 VMware image qualiﬁcation, but not heavily exercised: • vmw_vmci and related vsock interface (virtual socket transport for the VMware guest agent) • vmw_balloon memory balloon device • VMware SVGA controller • legacy AT keyboard and PS/2 mouse devices The VMware guest agent package (open-vm-tools) is available and installed by default in the AL2023 VMware OVA images. Boot mode (UEFI and BIOS) support for AL2023 on VMware As of the 2023.3.20231211 release, the AL2023 VMware OVA image has been validated in both legacy BIOS and UEFI boot modes. The OVA default conﬁguration is still legacy BIOS but can be changed by the user. Important Secure Boot support requires UEFI, which has not been validated for AL2023 running on VMware. Limitations running AL2023 on VMware There are some known limitations in running AL2023 on VMware. VMware Requirements 340 Amazon Linux 2023 Note User Guide Code implementing some of the listed unsupported functionality may exist in AL2023 and function correctly. The list of unsupported functionality exists so that customers can make informed decisions about what to rely upon working today, and what the Amazon Linux team will qualify as working as part of future updates. Known limitations with running AL2023 on VMware • UEFI Secure Boot is not currently validated with AL2023 on VMware. • Hot plugging and unplugging CPU, memory, or any other device type is not supported. • VM hibernation is not supported. • VM migration is not supported. • Passthrough of any device such as through PCI Passthrough, or USB Passthrough is not supported. Requirements for running Amazon Linux 2023 on Hyper-V This section covers the requirements for running Amazon Linux 2023 on Hyper-V. The Hyper-V images of AL2023 are available only for the x86-64 architecture. Hyper-V images for aarch64 are not available or supported at this time. This section covers additional requirements on top of the base AL2023 system requirements for the Hyper-V images. Topics • Hyper-V host requirements for running Amazon Linux 2023 on Hyper-V • Device support for Amazon Linux 2023 on Hyper-V • Limitations running Amazon Linux 2023 on Hyper-V Hyper-V host requirements for running Amazon Linux 2023 on Hyper-V The main qualiﬁcation of Amazon Linux 2023 on Hyper-V happens on Windows Server 2022 running on an EC2 c5.metal instance. Hyper-V Requirements 341 Amazon Linux 2023 User Guide Device support for Amazon Linux 2023 on Hyper-V Amazon Linux 2023 is tested on both Generation 1 and Generation 2 Hyper-V virtual machines with the following set of virtualized hardware: • Generation 1 (legacy BIOS boot) VM • Generation 2 (UEFI boot - No secure boot) VM • The following device models are tested for use with AL2023 Hyper-V images: • Hyper-V virtual storage hv_storvsc for the root disk and the emulated CD-ROM drive on Generation 2 VMs • Emulated PIIX IDE ata_piix for the virtual CD-ROM drive on Generation 1 VMs • Hyper-V virtual ethernet hv_netvsc • The following device models are enabled but lightly tested: • Legacy VGA text mode on Generation 1 VMs • UEFI Firmware based framebuﬀer simpledrmfb on Generation 2 VMs • Hyper-V Balloon hv_balloon • Hyper-V Balloon hv_balloon • Hyper-V HID/Mouse
al2023-ug-075	al2023-ug.pdf	75	• Generation 2 (UEFI boot - No secure boot) VM • The following device models are tested for use with AL2023 Hyper-V images: • Hyper-V virtual storage hv_storvsc for the root disk and the emulated CD-ROM drive on Generation 2 VMs • Emulated PIIX IDE ata_piix for the virtual CD-ROM drive on Generation 1 VMs • Hyper-V virtual ethernet hv_netvsc • The following device models are enabled but lightly tested: • Legacy VGA text mode on Generation 1 VMs • UEFI Firmware based framebuﬀer simpledrmfb on Generation 2 VMs • Hyper-V Balloon hv_balloon • Hyper-V Balloon hv_balloon • Hyper-V HID/Mouse hid_hyperv • The following device modes are not enabled in AL2023 at this time: • Hyper-V PCI pass-through • Hyper-V DRM Graphics Important For Generation 2 virtual machines, Secure Boot is not supported and must be disabled prior to launching the virtual machine for a successful boot of Amazon Linux 2023. Hyper- V currently only supports Secure Boot with software components signed by Microsoft's own keys while the Amazon Linux bootloader is signed by an Amazon private key. Hyper-V doesn’t support importing 3rd party keys at this point. Limitations running Amazon Linux 2023 on Hyper-V The following are some known limitations in running Amazon Linux 2023 on Hyper-V: Hyper-V Requirements 342 Amazon Linux 2023 Note User Guide Code implementing some of the listed unsupported functionality may exist in AL2023 and function correctly. The list of unsupported functionality exists so that customers can make informed decisions about what to rely upon working today, and what the Amazon Linux team will qualify as working as part of future updates. Known Limitations with running AL2023 on Hyper-V • UEFI Secure Boot mode is not currently supported nor functional with AL2023 on Hyper-V • Hot plugging and unplugging CPU, memory, or any other device type is not supported. • Virtual Machine (VM) hibernation is not supported. • Virtual Machine (VM) migration is not supported. • Passthrough of any device such as through PCI Passthrough, or USB Passthrough is not supported. Amazon Linux 2023 Set up and cloud-init conﬁguration when used outside Amazon EC2 This section covers how to set up and conﬁgure a Amazon Linux 2023 virtual machine when not run directly on Amazon EC2, such as when on KVM, VMware, or Hyper-V. By default, an Amazon Linux 2023 virtual machine images don’t come provisioned with any user password or ssh key and will obtain its network conﬁguration via DHCP on the ﬁrst discovered network interface. This means that by default, without additional conﬁguration, there is no way to connect to the resulting virtual machine. Thus, some form of conﬁguration needs to be provided to the virtual machine. The standard mechanism to do this for Amazon Linux is via cloud-init data sources. Amazon Linux 2023 has been qualiﬁed with the following data sources: NoCloud This is the traditional method of conﬁguring on-premises images via a virtual CD-ROM containing a seed ISO9660 image with cloud-init conﬁguration ﬁles. AL2023 VM conﬁguration 343 Amazon Linux 2023 VMware User Guide Amazon Linux 2023 additionally supports conﬁguring VMware images running on vSphere via the VMware speciﬁc data source via VMware guestinfo.userdata and guestinfo.metadata. Note The conﬁguration of the data sources can diﬀer from Amazon Linux 2. More speciﬁcally, Amazon Linux 2023 uses systemd-networkd for its conﬁguration and requires the use of cloud-init "Networking Conﬁg Version 2" as documented in the cloud-init network conﬁguration documentation. The complete documentation for cloud-init conﬁguration mechanisms for the version of cloud-init packaged in Amazon Linux 2023 can be found in the upstream cloud-init documentation. NoCloud (seed.iso) cloud-init conﬁguration for Amazon Linux 2023 on KVM and VMware This section covers how to create and use a seed.iso image to conﬁgure Amazon Linux 2023 running on KVM or VMware. Because KVM and VMware environments do not have Amazon EC2 Instance Meta Data Service (IMDS), an alternate method of conﬁguring Amazon Linux 2023 is required, and providing a seed.iso image is one of those methods. The seed.iso boot image includes the initial conﬁguration information that is needed to boot and conﬁgure your new virtual machine, such as the network conﬁguration, host name, and user data. Note The seed.iso image includes only the conﬁguration information required to boot the VM. It does not include the Amazon Linux 2023 operating system ﬁles. To generate the seed.iso image, you need at least two conﬁguration ﬁles, sometimes three: NoCloud seed.iso based conﬁguration 344 Amazon Linux 2023 meta-data User Guide This ﬁle typically includes the hostname for the virtual machine. user-data This ﬁle typically conﬁgures user accounts, their passwords, ssh key pairs, and/or access mechanisms. By default, the Amazon Linux 2023 KVM and VMware images create an ec2-user user account. You can use the user-data conﬁguration ﬁle to set the password and/or ssh keys for this default user account. network-config (optional) This
al2023-ug-076	al2023-ug.pdf	76	the VM. It does not include the Amazon Linux 2023 operating system ﬁles. To generate the seed.iso image, you need at least two conﬁguration ﬁles, sometimes three: NoCloud seed.iso based conﬁguration 344 Amazon Linux 2023 meta-data User Guide This ﬁle typically includes the hostname for the virtual machine. user-data This ﬁle typically conﬁgures user accounts, their passwords, ssh key pairs, and/or access mechanisms. By default, the Amazon Linux 2023 KVM and VMware images create an ec2-user user account. You can use the user-data conﬁguration ﬁle to set the password and/or ssh keys for this default user account. network-config (optional) This ﬁle typically provides a network conﬁguration for the virtual machine which will override the default one. The default conﬁguration is to use DHCP on the ﬁrst available network interface. Create the seed.iso disk image 1. On a Linux or macOS computer, create a new folder named seedconfig and navigate into it. Note Using Windows or another Operating System to complete these steps is possible, but you will have to ﬁnd the equivalent tool to mkisofs to complete creating the seed.iso image. 2. Create the meta-data conﬁguration ﬁle. a. Create a new ﬁle named meta-data. b. Open the meta-data ﬁle using your preferred editor and add the following, replacing vm-hostname with the host name for the VM: #cloud-config local-hostname: vm-hostname c. Save and close the meta-data conﬁguration ﬁle. 3. Create the user-data conﬁguration ﬁle. a. Create a new ﬁle named user-data. NoCloud seed.iso based conﬁguration 345 Amazon Linux 2023 User Guide b. Open the user-data ﬁle using your preferred editor and add the following, making substitutions as needed: #cloud-config #vim:syntax=yaml users: # A user by the name 'ec2-user' is created in the image by default. - default - name: ec2-user ssh_authorized_keys: - ssh-rsa ssh-key # In the above line, replace ssh key with the content of your ssh public key. c. You can optionally add more user accounts to the user-data conﬁguration ﬁle. You can specify additional user accounts, their access mechanisms, passwords, and key pairs. For more information about the supported directives, see the upstream cloud- init documentation. d. Save and close the user-data conﬁguration ﬁle. 4. (Optional) Create the network-config conﬁguration ﬁle. a. Create a new ﬁle named network-config. b. Open the network-config ﬁle using your preferred editor and add the following, replacing the various IP addresses with the appropriate ones for your setup. #cloud-config version: 2 ethernets: enp1s0: addresses: - 192.168.122.161/24 gateway4: 192.168.122.1 nameservers: addresses: 192.168.122.1 Note cloud-init network conﬁguration provides mechanisms to match against the MAC address of the interface instead of specifying the interface name which can NoCloud seed.iso based conﬁguration 346 Amazon Linux 2023 User Guide change depending on the VM conﬁguration. This (and more) cloud-init features for network conﬁguration are described in more detail in the upstream cloud- init Network Conﬁg Version 2 documentation. c. Save and close the network-config conﬁguration ﬁle. 5. Create the seed.iso disk image using the meta-data, user-data, and optional network- config conﬁguration ﬁles created in the previous steps. Do one of the following, depending on the OS you are creating the seed.iso disk image on. • • • On Linux systems, use a tool such as mkisofs or genisoimage to create the completed seed.iso ﬁle. Navigate into the seedconfig folder, and run the following command: $ mkisofs -output seed.iso -volid cidata -joliet -rock user-data meta-data If you use a network-config, include it in the invocation of mkisofs: $ mkisofs -output seed.iso -volid cidata -joliet -rock user-data meta-data network-config On macOS systems, you can use a tool such as hdiutil to generate the ﬁnished seed.iso ﬁle. Since hdiutil takes a pathname rather than a list of ﬁles, the same invocation can be used regardless of if a network-config conﬁguration ﬁle has been created or not. $ hdiutil makehybrid -o seed.iso -hfs -joliet -iso -default-volume-name cidata seedconfig/ 6. The resulting seed.iso ﬁle can now be attached to your new Amazon Linux 2023 Virtual Machine using a virtual CD-ROM drive for cloud-init to ﬁnd on ﬁrst boot and apply the conﬁguration to the system. VMware guestinfo cloud-init conﬁguration for AL2023 on VMware VMware environments do not have the Amazon EC2 Instance Meta Data Service (IMDS), so an alternate method of conﬁguring AL2023 is required. This section describes how to use an alternative conﬁguration mechanism to the seed.iso virtual CD-ROM drive that is available in VMware vSphere. VMware guestinfo based conﬁguration 347 Amazon Linux 2023 User Guide This method of conﬁguration uses the VMware extraconfig mechanism to provide conﬁguration data to cloud-init. For each of the following keys, a corresponding keyname.encoding property must be provided. The following keys can be provided to the VMware extraconfig mechanism. guestinfo.metadata JSON or YAML containing cloud-init meta-data guestinfo.userdata A YAML document containing cloud-init user-data in the cloud-config format. guestinfo.vendordata (optional) YAML containing cloud-init vendor-data The corresponding encoding
al2023-ug-077	al2023-ug.pdf	77	is required. This section describes how to use an alternative conﬁguration mechanism to the seed.iso virtual CD-ROM drive that is available in VMware vSphere. VMware guestinfo based conﬁguration 347 Amazon Linux 2023 User Guide This method of conﬁguration uses the VMware extraconfig mechanism to provide conﬁguration data to cloud-init. For each of the following keys, a corresponding keyname.encoding property must be provided. The following keys can be provided to the VMware extraconfig mechanism. guestinfo.metadata JSON or YAML containing cloud-init meta-data guestinfo.userdata A YAML document containing cloud-init user-data in the cloud-config format. guestinfo.vendordata (optional) YAML containing cloud-init vendor-data The corresponding encoding properties ( guestinfo.metadata.encoding, guestinfo.userdata.encoding, and guestinfo.vendordata.encoding) can contain: base64 The content of the property is base64 encoded. gzip+base64 The content of the property is compressed with gzip after base64 encoding. Note The seed.iso method supports a separate (optional) network-config conﬁguration ﬁle. VMware guestinfo diﬀers in how the networking conﬁguration is provided. Additional information is provided in the following section. If an explicit network conﬁguration is desired, it should be embedded in the metadata in the form of two YAML or JSON properties: network Contains the encoded network conﬁguration in JSON or YAML form. VMware guestinfo based conﬁguration 348 Amazon Linux 2023 network.encoding User Guide Contains the encoding of the above network conﬁguration data. The cloud-init supported encodings are the same as for the guestinfo data: base64 and gzip+base64. Example Using the VMware vSphere govc CLI tool to pass conﬁguration with guestinfo 1. Prepare the meta-data, user-data, and optional network-config conﬁguration ﬁles as described in NoCloud (seed.iso) cloud-init conﬁguration for Amazon Linux 2023 on KVM and VMware. 2. Convert the conﬁguration ﬁles into formats usable by VMware guestinfo. # 'meta-data', `user-data` and `network-config` are the configuration # files in the same format that would be used by a NoCloud (seed.iso) # data source, read-them and convert them to VMware guestinfo # # The VM_NAME variable is assumed to be set to the name of the VM # It is assumed that the necessary govc environment (credentials etc...) are already set metadata=$(cat "meta-data") userdata=$(cat "user-data") if [ -e "network-config" ] ; then # We need to embed the network config inside the meta-data netconf=$(base64 -w0 "network-config") metadata=$(printf "%s\nnetwork: %s\nnetwork.encoding: base64" "$metadata" "$netconf") fi metadata=$(base64 -w0 <<< "$metadata") govc vm.change -vm "$VM_NAME" \ -e guestinfo.metadata="$metadata" \ -e guestinfo.metadata.encoding="base64" userdata=$(base64 -w0 <<< "$userdata") govc vm.change -vm "$VM_NAME" \ -e guestinfo.userdata="$userdata" \ -e guestinfo.userdata.encoding="base64" VMware guestinfo based conﬁguration 349 Amazon Linux 2023 User Guide Comparing packages installed on Amazon Linux 2023 standard AMI with the AL2023 KVM Image A comparison of the RPMs present on the AL2023 standard AMI compared with the RPMs present on the AL2023 KVM image. Package acl acpid alternatives AMI 2.3.1 2.0.32 1.15 amazon-chrony-config 4.3 amazon-ec2-net-utils 2.5.1 amazon-linux-onprem amazon-linux-repo- cdn KVM 2.3.1 1.15 1.2 2023.6.20241031 amazon-linux-repo-s3 2023.6.20241031 amazon-linux-sb-keys 2023.1 amazon-onprem-netw ork amazon-rpm-config 228 2023.1 1.2 228 amazon-ssm-agent 3.3.987.0 3.3.987.0 amd-ucode-firmware 20210208 (noarch) 20210208 (noarch) at attr 3.1.23 2.5.1 3.1.23 2.5.1 AL2023 package list comparison for the standard AMI and KVM image 350 Amazon Linux 2023 Package audit audit-libs aws-cfn-bootstrap awscli-2 basesystem bash bash-completion bc bind-libs bind-license bind-utils binutils boost-filesystem boost-system boost-thread bzip2 bzip2-libs AMI 3.0.6 3.0.6 2.0 2.15.30 11 5.2.15 2.11 1.07.1 9.18.28 9.18.28 9.18.28 2.39 1.75.0 1.75.0 1.75.0 1.0.8 1.0.8 User Guide KVM 3.0.6 3.0.6 2.15.30 11 5.2.15 2.11 1.07.1 9.18.28 9.18.28 9.18.28 2.39 1.75.0 1.75.0 1.75.0 1.0.8 1.0.8 ca-certificates 2023.2.68 2023.2.68 c-ares checkpolicy 1.19.1 3.4 3.4 AL2023 package list comparison for the standard AMI and KVM image 351 Amazon Linux 2023 Package chkconfig chrony cloud-init cloud-init-cfg-ec2 cloud-init-cfg-onp rem cloud-utils-growpart coreutils coreutils-common cpio cracklib cracklib-dicts crontabs AMI 1.15 4.3 22.2.2 22.2.2 0.31 8.32 8.32 2.13 2.9.6 2.9.6 1.11 crypto-policies 20220428 crypto-policies-sc 20220428 ripts cryptsetup cryptsetup-libs curl-minimal cyrus-sasl-lib cyrus-sasl-plain 2.6.1 2.6.1 8.5.0 2.1.27 2.1.27 User Guide KVM 1.15 4.3 22.2.2 22.2.2 0.31 8.32 8.32 2.13 2.9.6 2.9.6 1.11 20220428 20220428 2.6.1 2.6.1 8.5.0 2.1.27 2.1.27 AL2023 package list comparison for the standard AMI and KVM image 352 Amazon Linux 2023 Package dbus dbus-broker dbus-common dbus-libs AMI 1.12.28 32 1.12.28 1.12.28 device-mapper 1.02.185 device-mapper-libs 1.02.185 diffutils dnf dnf-data 3.8 4.14.0 4.14.0 dnf-plugin-release- 1.2 notification dnf-plugins-core 4.3.0 dnf-plugin-support- 1.2 info dnf-utils dosfstools dracut dracut-config-ec2 dracut-config-gene ric dwz 4.3.0 4.2 055 3.0 055 0.14 User Guide KVM 1.12.28 32 1.12.28 1.12.28 1.02.185 1.02.185 3.8 4.14.0 4.14.0 1.2 4.3.0 1.2 4.3.0 4.2 055 055 0.14 AL2023 package list comparison for the standard AMI and KVM image 353 Amazon Linux 2023 Package dyninst e2fsprogs e2fsprogs-libs ec2-hibinit-agent ec2-instance-connect ec2-instance-conne ct-selinux ec2-utils ed efi-filesystem efi-srpm-macros efivar efivar-libs AMI 10.2.1 1.46.5 1.46.5 1.0.8 1.1 1.1 2.2.0 1.14.2 5 5 38 38 elfutils-debuginfod- 0.188 client elfutils-default-y 0.188 ama-scope elfutils-libelf elfutils-libs ethtool expat 0.188 0.188 5.15 2.5.0 User Guide KVM 10.2.1 1.46.5 1.46.5 1.14.2 5 5 38 38 0.188 0.188 0.188 0.188 5.15 2.5.0 AL2023 package list comparison for the standard
al2023-ug-078	al2023-ug.pdf	78	User Guide KVM 1.12.28 32 1.12.28 1.12.28 1.02.185 1.02.185 3.8 4.14.0 4.14.0 1.2 4.3.0 1.2 4.3.0 4.2 055 055 0.14 AL2023 package list comparison for the standard AMI and KVM image 353 Amazon Linux 2023 Package dyninst e2fsprogs e2fsprogs-libs ec2-hibinit-agent ec2-instance-connect ec2-instance-conne ct-selinux ec2-utils ed efi-filesystem efi-srpm-macros efivar efivar-libs AMI 10.2.1 1.46.5 1.46.5 1.0.8 1.1 1.1 2.2.0 1.14.2 5 5 38 38 elfutils-debuginfod- 0.188 client elfutils-default-y 0.188 ama-scope elfutils-libelf elfutils-libs ethtool expat 0.188 0.188 5.15 2.5.0 User Guide KVM 10.2.1 1.46.5 1.46.5 1.14.2 5 5 38 38 0.188 0.188 0.188 0.188 5.15 2.5.0 AL2023 package list comparison for the standard AMI and KVM image 354 User Guide Amazon Linux 2023 Package file file-libs filesystem findutils fonts-srpm-macros fstrm fuse-libs gawk gdbm-libs gdisk gettext gettext-libs ghc-srpm-macros glib2 glibc glibc-all-langpacks glibc-common glibc-gconv-extra glibc-locale-source gmp AMI 5.39 5.39 3.14 4.8.0 2.0.5 0.6.1 2.9.9 5.1.0 1.19 1.0.8 0.21 0.21 1.5.0 KVM 5.39 5.39 3.14 4.8.0 2.0.5 0.6.1 2.9.9 5.1.0 1.19 1.0.8 0.21 0.21 1.5.0 2.74.7 2.74.7 2.34 2.34 2.34 2.34 2.34 6.2.1 2.34 2.34 2.34 2.34 2.34 6.2.1 AL2023 package list comparison for the standard AMI and KVM image 355 Amazon Linux 2023 Package gnupg2-minimal gnutls go-srpm-macros gpgme gpm-libs grep groff-base grub2-common AMI 2.3.7 3.8.0 3.2.0 1.15.1 1.20.7 3.8 1.22.4 2.06 User Guide KVM 2.3.7 3.8.0 3.2.0 1.15.1 1.20.7 3.8 1.22.4 2.06 grub2-efi-aa64-ec2 2.06 (aarch64) 2.06 (aarch64) grub2-efi-x64-ec2 2.06 (x86_64) 2.06 (x86_64) grub2-pc grub2-pc-modules grub2-tools grub2-tools-minimal grubby gssproxy gzip hostname hunspell 2.06 2.06 2.06 8.40 0.8.4 1.12 3.23 1.7.0 2.06 (x86_64) 2.06 (noarch) 2.06 2.06 8.40 0.8.4 1.12 3.23 1.7.0 hunspell-en 0.20140811.1 0.20140811.1 AL2023 package list comparison for the standard AMI and KVM image 356 Amazon Linux 2023 User Guide Package AMI KVM hunspell-en-GB 0.20140811.1 0.20140811.1 hunspell-en-US 0.20140811.1 0.20140811.1 hunspell-filesystem 1.7.0 hwdata info inih initscripts iproute iputils irqbalance jansson jemalloc jitterentropy jq json-c kbd kbd-misc kernel kernel-libbpf kernel-livepatch-r epo-cdn 0.384 6.7 49 10.09 6.10.0 1.7.0 0.384 6.7 49 10.09 6.10.0 20210202 20210202 1.9.0 2.14 5.2.1 3.4.1 1.7.1 0.14 2.4.0 2.4.0 6.1.112 6.1.112 1.9.0 2.14 5.2.1 3.4.1 0.14 2.4.0 2.4.0 6.1.112 6.1.112 2023.6.20241031 AL2023 package list comparison for the standard AMI and KVM image 357 Amazon Linux 2023 User Guide Package AMI KVM kernel-livepatch-r 2023.6.20241031 epo-s3 kernel-modules-extra kernel-modules-ext ra-common kernel-srpm-macros 1.0 kernel-tools 6.1.112 1.6.3 1.6.3 29 29 0.9.7 1.21.3 608 2.3.1 0.3.111 3.7.4 keyutils keyutils-libs kmod kmod-libs kpatch-runtime krb5-libs less libacl libaio libarchive libargon2 libassuan libattr libbasicobjects 6.1.112 6.1.112 1.0 6.1.112 1.6.3 1.6.3 29 29 0.9.7 1.21.3 608 2.3.1 0.3.111 3.7.4 20171227 20171227 2.5.5 2.5.1 0.1.1 2.5.5 2.5.1 0.1.1 AL2023 package list comparison for the standard AMI and KVM image 358 Amazon Linux 2023 Package libblkid libcap libcap-ng libcbor libcollection libcom_err libcomps libconfig libcurl-minimal libdb libdhash libdnf libeconf libedit libev libevent libfdisk libffi libfido2 libgcc AMI 2.37.4 2.48 0.8.2 0.7.0 0.7.0 1.46.5 0.1.20 1.7.2 8.5.0 5.3.28 0.5.0 0.69.0 0.4.0 3.1 4.33 2.1.12 2.37.4 3.4.4 1.10.0 11.4.1 User Guide KVM 2.37.4 2.48 0.8.2 0.7.0 0.7.0 1.46.5 0.1.20 1.7.2 8.5.0 5.3.28 0.69.0 0.4.0 3.1 4.33 2.1.12 2.37.4 3.4.4 1.10.0 11.4.1 AL2023 package list comparison for the standard AMI and KVM image 359 Amazon Linux 2023 Package libgcrypt libgomp libgpg-error libibverbs libidn2 libini_config libkcapi libkcapi-hmaccalc libldb libmaxminddb libmetalink libmnl libmodulemd libmount libnfsidmap libnghttp2 libnl3 libpath_utils libpcap libpipeline AMI 1.10.2 11.4.1 1.42 48.0 2.3.2 1.3.1 1.4.0 1.4.0 2.6.2 1.5.2 0.1.3 1.0.4 2.13.0 2.37.4 2.5.4 1.59.0 3.5.0 0.2.1 1.10.1 1.5.3 User Guide KVM 1.10.2 11.4.1 1.42 48.0 2.3.2 1.3.1 1.4.0 1.4.0 1.5.2 0.1.3 1.0.4 2.13.0 2.37.4 2.5.4 1.59.0 3.5.0 0.2.1 1.10.1 1.5.3 AL2023 package list comparison for the standard AMI and KVM image 360 Amazon Linux 2023 Package libpkgconf libpsl libpwquality libref_array librepo AMI 1.8.0 0.21.1 1.4.4 0.1.5 1.14.5 libreport-filesystem 2.15.2 libseccomp libselinux libselinux-utils libsemanage libsepol libsigsegv libsmartcols libsolv libss libsss_certmap libsss_idmap libsss_nss_idmap libsss_sudo libstdc++ 2.5.3 3.4 3.4 3.4 3.4 2.13 2.37.4 0.7.22 1.46.5 2.9.4 2.9.4 2.9.4 2.9.4 11.4.1 User Guide KVM 1.8.0 0.21.1 1.4.4 0.1.5 1.14.5 2.15.2 2.5.3 3.4 3.4 3.4 3.4 2.13 2.37.4 0.7.22 1.46.5 2.9.4 2.9.4 11.4.1 AL2023 package list comparison for the standard AMI and KVM image 361 Amazon Linux 2023 Package libstoragemgmt libtalloc libtasn1 libtdb libtevent libtextstyle libtirpc libunistring libuser libutempter libuuid libuv libverto libverto-libev libxcrypt libxml2 libyaml libzstd AMI 1.9.4 2.3.4 4.19.0 1.4.7 0.13.0 0.21 1.3.3 0.9.10 0.63 1.2.1 2.37.4 1.47.0 0.3.2 0.3.2 4.4.33 2.10.4 0.2.5 1.5.5 User Guide KVM 1.9.4 4.19.0 0.21 1.3.3 0.9.10 0.63 1.2.1 2.37.4 1.47.0 0.3.2 0.3.2 4.4.33 2.10.4 0.2.5 1.5.5 linux-firmware-whe 20210208 (noarch) 20210208 (noarch) nce lm_sensors-libs 3.6.0 3.6.0 AL2023 package list comparison for the standard AMI and KVM image 362 Amazon Linux 2023 Package lmdb-libs logrotate lsof lua-libs lua-srpm-macros lz4-libs man-db man-pages AMI 0.9.29 3.20.1 4.94.0 5.4.4 1 1.9.4 2.9.3 5.10 User Guide KVM 0.9.29 3.20.1 4.94.0 5.4.4 1 1.9.4 2.9.3 5.10 microcode_ctl 2.1 (x86_64) 2.1 (x86_64) mpfr nano ncurses ncurses-base ncurses-libs nettle net-tools newt nfs-utils npth nspr 4.1.0 4.1.0 5.8 6.2 6.2 6.2 3.8 2.0 0.52.21 2.5.4 1.6
al2023-ug-079	al2023-ug.pdf	79	0.2.5 1.5.5 User Guide KVM 1.9.4 4.19.0 0.21 1.3.3 0.9.10 0.63 1.2.1 2.37.4 1.47.0 0.3.2 0.3.2 4.4.33 2.10.4 0.2.5 1.5.5 linux-firmware-whe 20210208 (noarch) 20210208 (noarch) nce lm_sensors-libs 3.6.0 3.6.0 AL2023 package list comparison for the standard AMI and KVM image 362 Amazon Linux 2023 Package lmdb-libs logrotate lsof lua-libs lua-srpm-macros lz4-libs man-db man-pages AMI 0.9.29 3.20.1 4.94.0 5.4.4 1 1.9.4 2.9.3 5.10 User Guide KVM 0.9.29 3.20.1 4.94.0 5.4.4 1 1.9.4 2.9.3 5.10 microcode_ctl 2.1 (x86_64) 2.1 (x86_64) mpfr nano ncurses ncurses-base ncurses-libs nettle net-tools newt nfs-utils npth nspr 4.1.0 4.1.0 5.8 6.2 6.2 6.2 3.8 2.0 0.52.21 2.5.4 1.6 4.35.0 5.8 6.2 6.2 6.2 3.8 2.0 0.52.21 2.5.4 1.6 4.35.0 AL2023 package list comparison for the standard AMI and KVM image 363 Amazon Linux 2023 Package nss nss-softokn nss-softokn-freebl nss-sysinit nss-util ntsysv numactl-libs AMI 3.90.0 3.90.0 3.90.0 3.90.0 3.90.0 1.15 2.0.14 ocaml-srpm-macros 6 oniguruma 6.9.7.1 openblas-srpm-macros 2 openldap openssh openssh-clients openssh-server openssl openssl-libs openssl-pkcs11 os-prober p11-kit p11-kit-trust 2.4.57 8.7p1 8.7p1 8.7p1 3.0.8 3.0.8 0.4.12 1.77 0.24.1 0.24.1 User Guide KVM 3.90.0 3.90.0 3.90.0 3.90.0 3.90.0 1.15 2.0.14 6 2 2.4.57 8.7p1 8.7p1 8.7p1 3.0.8 3.0.8 0.4.12 1.77 0.24.1 0.24.1 AL2023 package list comparison for the standard AMI and KVM image 364 Amazon Linux 2023 Package package-notes-srpm- macros pam parted passwd pciutils pciutils-libs pcre2 pcre2-syntax perl-Carp perl-Class-Struct perl-constant perl-DynaLoader perl-Encode perl-Errno perl-Exporter perl-Fcntl perl-File-Basename perl-File-Path perl-File-stat AMI 0.4 1.5.1 3.4 0.80 3.7.0 3.7.0 10.40 10.40 1.50 0.66 1.33 1.47 3.15 1.30 5.74 1.13 2.85 2.18 1.09 User Guide KVM 0.4 1.5.1 3.4 0.80 3.7.0 3.7.0 10.40 10.40 1.50 0.66 1.33 1.47 3.15 1.30 5.74 1.13 2.85 2.18 1.09 perl-File-Temp 0.231.100 0.231.100 AL2023 package list comparison for the standard AMI and KVM image 365 Amazon Linux 2023 Package perl-Getopt-Long perl-Getopt-Std AMI 2.52 1.12 perl-HTTP-Tiny 0.078 User Guide KVM 2.52 1.12 0.078 perl-if 0.60.800 0.60.800 perl-interpreter 5.32.1 perl-IO perl-IPC-Open3 perl-libs perl-MIME-Base64 perl-mro perl-overload perl-overloading perl-parent perl-PathTools perl-Pod-Escapes perl-podlators 1.43 1.21 5.32.1 3.16 1.23 1.31 0.02 0.238 3.78 1.07 4.14 5.32.1 1.43 1.21 5.32.1 3.16 1.23 1.31 0.02 0.238 3.78 1.07 4.14 perl-Pod-Perldoc 3.28.01 3.28.01 perl-Pod-Simple perl-Pod-Usage perl-POSIX 3.42 2.01 1.94 3.42 2.01 1.94 AL2023 package list comparison for the standard AMI and KVM image 366 Amazon Linux 2023 Package perl-Scalar-List-U tils perl-SelectSaver perl-Socket perl-srpm-macros perl-Storable perl-subs perl-Symbol perl-Term-ANSIColor perl-Term-Cap perl-Text-ParseWords AMI 1.56 1.02 2.032 1 3.21 1.03 1.08 5.01 1.17 3.30 User Guide KVM 1.56 1.02 2.032 1 3.21 1.03 1.08 5.01 1.17 3.30 perl-Text-Tabs+Wrap 2021.0726 2021.0726 perl-Time-Local 1.300 perl-vars pkgconf pkgconf-m4 pkgconf-pkg-config policycoreutils policycoreutils-py thon-utils popt 1.05 1.8.0 1.8.0 1.8.0 3.4 3.4 1.18 1.300 1.05 1.8.0 1.8.0 1.8.0 3.4 1.18 AL2023 package list comparison for the standard AMI and KVM image 367 Amazon Linux 2023 Package procps-ng protobuf-c psacct psmisc AMI 3.3.17 1.4.1 6.6.4 23.4 User Guide KVM 3.3.17 1.4.1 6.6.4 23.4 publicsuffix-list- 20240212 20240212 dafsa python3 python3-attrs python3-audit 3.9.16 20.3.0 3.0.6 python3-awscrt 0.19.19 python3-babel python3-cffi python3-chardet python3-colorama python3-configobj 2.9.1 1.14.5 4.0.0 0.4.4 5.0.6 python3-cryptography 36.0.1 python3-daemon python3-dateutil python3-dbus python3-distro python3-dnf 2.3.0 2.8.1 1.2.18 1.5.0 4.14.0 3.9.16 20.3.0 3.0.6 0.19.19 2.9.1 1.14.5 4.0.0 0.4.4 5.0.6 36.0.1 2.8.1 1.2.18 1.5.0 4.14.0 AL2023 package list comparison for the standard AMI and KVM image 368 Amazon Linux 2023 User Guide Package AMI python3-dnf-plugins- 4.3.0 core python3-docutils python3-gpg python3-hawkey python3-idna python3-jinja2 python3-jmespath python3-jsonpatch python3-jsonpointer python3-jsonschema python3-libcomps python3-libdnf python3-libs python3-libselinux python3-libsemanage 0.16 1.15.1 0.69.0 2.10 2.11.3 0.10.0 1.21 2.0 3.2.0 0.1.20 0.69.0 3.9.16 3.4 3.4 python3-libstorage 1.9.4 mgmt python3-lockfile 0.12.2 python3-markupsafe 1.1.1 python3-netifaces 0.10.6 KVM 4.3.0 0.16 1.15.1 0.69.0 2.10 2.11.3 0.10.0 1.21 2.0 3.2.0 0.1.20 0.69.0 3.9.16 3.4 3.4 1.9.4 1.1.1 0.10.6 AL2023 package list comparison for the standard AMI and KVM image 369 Amazon Linux 2023 Package python3-oauthlib AMI 3.0.2 python3-pip-wheel 21.3.1 python3-ply python3-policycore utils 3.11 3.4 python3-prettytable 0.7.2 python3-prompt-too 3.0.24 lkit python3-pycparser 2.20 python3-pyrsistent 0.17.3 python3-pyserial python3-pysocks 3.4 1.7.1 python3-pytz 2022.7.1 python3-pyyaml python3-requests python3-rpm 5.4.1 2.25.1 4.16.1.3 python3-ruamel-yaml 0.16.6 python3-ruamel-yaml- 0.1.2 clib python3-setools 4.4.1 python3-setuptools 59.6.0 User Guide KVM 3.0.2 21.3.1 3.11 3.4 0.7.2 3.0.24 2.20 0.17.3 3.4 1.7.1 2022.7.1 5.4.1 2.25.1 4.16.1.3 0.16.6 0.1.2 4.4.1 59.6.0 AL2023 package list comparison for the standard AMI and KVM image 370 Amazon Linux 2023 User Guide Package AMI python3-setuptools- 59.6.0 wheel python3-six python3-systemd 1.15.0 235 python3-urllib3 1.25.10 python3-wcwidth python-chevron python-srpm-macros quota quota-nls readline rng-tools rootfiles rpcbind rpm rpm-build-libs rpm-libs 0.2.5 0.13.1 3.9 4.06 4.06 8.1 6.14 8.1 1.2.6 4.16.1.3 4.16.1.3 4.16.1.3 rpm-plugin-selinux 4.16.1.3 rpm-plugin-systemd- 4.16.1.3 inhibit rpm-sign-libs 4.16.1.3 KVM 59.6.0 1.15.0 235 1.25.10 0.2.5 3.9 4.06 4.06 8.1 6.14 8.1 1.2.6 4.16.1.3 4.16.1.3 4.16.1.3 4.16.1.3 4.16.1.3 4.16.1.3 AL2023 package list comparison for the standard AMI and KVM image 371 Amazon Linux 2023 Package rsync rust-srpm-macros sbsigntools screen sed AMI 3.2.6 21 0.9.4 4.8.0 4.8 selinux-policy 38.1.45 selinux-policy-tar 38.1.45 geted setup shadow-utils slang sqlite-libs sssd-client sssd-common sssd-kcm sssd-nfs-idmap strace sudo sysctl-defaults sysstat systemd 2.13.7 4.9 2.3.2 3.40.0 2.9.4 2.9.4 2.9.4 2.9.4 6.8 1.9.15 1.0 12.5.6 252.23
al2023-ug-080	al2023-ug.pdf	80	rpcbind rpm rpm-build-libs rpm-libs 0.2.5 0.13.1 3.9 4.06 4.06 8.1 6.14 8.1 1.2.6 4.16.1.3 4.16.1.3 4.16.1.3 rpm-plugin-selinux 4.16.1.3 rpm-plugin-systemd- 4.16.1.3 inhibit rpm-sign-libs 4.16.1.3 KVM 59.6.0 1.15.0 235 1.25.10 0.2.5 3.9 4.06 4.06 8.1 6.14 8.1 1.2.6 4.16.1.3 4.16.1.3 4.16.1.3 4.16.1.3 4.16.1.3 4.16.1.3 AL2023 package list comparison for the standard AMI and KVM image 371 Amazon Linux 2023 Package rsync rust-srpm-macros sbsigntools screen sed AMI 3.2.6 21 0.9.4 4.8.0 4.8 selinux-policy 38.1.45 selinux-policy-tar 38.1.45 geted setup shadow-utils slang sqlite-libs sssd-client sssd-common sssd-kcm sssd-nfs-idmap strace sudo sysctl-defaults sysstat systemd 2.13.7 4.9 2.3.2 3.40.0 2.9.4 2.9.4 2.9.4 2.9.4 6.8 1.9.15 1.0 12.5.6 252.23 User Guide KVM 3.2.6 21 0.9.4 4.8.0 4.8 38.1.45 38.1.45 2.13.7 4.9 2.3.2 3.40.0 2.9.4 6.8 1.9.15 1.0 12.5.6 252.23 AL2023 package list comparison for the standard AMI and KVM image 372 Amazon Linux 2023 Package systemd-libs systemd-networkd systemd-pam systemd-resolved systemd-udev AMI 252.23 252.23 252.23 252.23 252.23 User Guide KVM 252.23 252.23 252.23 252.23 252.23 system-release 2023.6.20241031 2023.6.20241031 systemtap-runtime tar tbb tcpdump tcsh time traceroute tzdata unzip update-motd userspace-rcu util-linux util-linux-core 4.8 1.34 2020.3 4.99.1 6.24.07 1.9 2.1.3 2024a 6.0 2.2 0.12.1 2.37.4 2.37.4 4.8 1.34 2020.3 4.99.1 6.24.07 1.9 2.1.3 2024a 6.0 2.2 0.12.1 2.37.4 2.37.4 vim-common 9.0.2153 9.0.2153 AL2023 package list comparison for the standard AMI and KVM image 373 User Guide Amazon Linux 2023 Package vim-data vim-enhanced vim-filesystem vim-minimal wget which words xfsdump xfsprogs xxd xxhash-libs xz xz-libs yum zip zlib zram-generator zram-generator-def aults zstd AMI 9.0.2153 9.0.2153 9.0.2153 9.0.2153 1.21.3 2.21 3.0 3.1.11 5.18.0 KVM 9.0.2153 9.0.2153 9.0.2153 9.0.2153 1.21.3 2.21 3.0 3.1.11 5.18.0 9.0.2153 9.0.2153 0.8.0 5.2.5 5.2.5 4.14.0 3.0 1.2.11 1.1.2 1.1.2 1.5.5 0.8.0 5.2.5 5.2.5 4.14.0 3.0 1.2.11 1.5.5 AL2023 package list comparison for the standard AMI and KVM image 374 Amazon Linux 2023 User Guide Comparing packages installed on Amazon Linux 2023 standard AMI with the AL2023 VMware OVA Image A comparison of the RPMs present on the AL2023 standard AMI compared with the RPMs present on the AL2023 VMware OVA image. Package acl acpid alternatives AMI 2.3.1 2.0.32 1.15 amazon-chrony-config 4.3 amazon-ec2-net-utils 2.5.1 amazon-linux-onprem amazon-linux-repo- cdn amazon-linux-repo-s3 2023.6.20241031 amazon-linux-sb-keys 2023.1 amazon-onprem-netw ork amazon-rpm-config 228 amazon-ssm-agent 3.3.987.0 amd-ucode-firmware 20210208 at attr 3.1.23 2.5.1 VMware OVA 2.3.1 1.15 1.2 2023.6.20241031 2023.1 1.2 228 3.3.987.0 20210208 3.1.23 2.5.1 AL2023 package list comparison for the standard AMI and VMware OVA image 375 Amazon Linux 2023 Package audit audit-libs aws-cfn-bootstrap awscli-2 basesystem bash bash-completion bc bind-libs bind-license bind-utils binutils boost-filesystem boost-system boost-thread bzip2 bzip2-libs AMI 3.0.6 3.0.6 2.0 2.15.30 11 5.2.15 2.11 1.07.1 9.18.28 9.18.28 9.18.28 2.39 1.75.0 1.75.0 1.75.0 1.0.8 1.0.8 User Guide VMware OVA 3.0.6 3.0.6 2.15.30 11 5.2.15 2.11 1.07.1 9.18.28 9.18.28 9.18.28 2.39 1.75.0 1.75.0 1.75.0 1.0.8 1.0.8 ca-certificates 2023.2.68 2023.2.68 c-ares checkpolicy 1.19.1 3.4 3.4 AL2023 package list comparison for the standard AMI and VMware OVA image 376 Amazon Linux 2023 Package chkconfig chrony cloud-init cloud-init-cfg-ec2 cloud-init-cfg-onp rem cloud-utils-growpart coreutils coreutils-common cpio cracklib cracklib-dicts crontabs AMI 1.15 4.3 22.2.2 22.2.2 0.31 8.32 8.32 2.13 2.9.6 2.9.6 1.11 crypto-policies 20220428 crypto-policies-sc 20220428 ripts cryptsetup cryptsetup-libs curl-minimal cyrus-sasl-lib cyrus-sasl-plain 2.6.1 2.6.1 8.5.0 2.1.27 2.1.27 User Guide VMware OVA 1.15 4.3 22.2.2 22.2.2 0.31 8.32 8.32 2.13 2.9.6 2.9.6 1.11 20220428 20220428 2.6.1 2.6.1 8.5.0 2.1.27 2.1.27 AL2023 package list comparison for the standard AMI and VMware OVA image 377 Amazon Linux 2023 Package dbus dbus-broker dbus-common dbus-libs AMI 1.12.28 32 1.12.28 1.12.28 device-mapper 1.02.185 device-mapper-libs 1.02.185 diffutils dnf dnf-data 3.8 4.14.0 4.14.0 dnf-plugin-release- 1.2 notification dnf-plugins-core 4.3.0 dnf-plugin-support- 1.2 info dnf-utils dosfstools dracut dracut-config-ec2 dracut-config-gene ric dwz 4.3.0 4.2 055 3.0 055 0.14 User Guide VMware OVA 1.12.28 32 1.12.28 1.12.28 1.02.185 1.02.185 3.8 4.14.0 4.14.0 1.2 4.3.0 1.2 4.3.0 4.2 055 055 0.14 AL2023 package list comparison for the standard AMI and VMware OVA image 378 Amazon Linux 2023 Package dyninst e2fsprogs e2fsprogs-libs ec2-hibinit-agent ec2-instance-connect ec2-instance-conne ct-selinux ec2-utils ed efi-filesystem efi-srpm-macros efivar efivar-libs AMI 10.2.1 1.46.5 1.46.5 1.0.8 1.1 1.1 2.2.0 1.14.2 5 5 38 38 elfutils-debuginfod- 0.188 client elfutils-default-y 0.188 ama-scope elfutils-libelf elfutils-libs ethtool expat 0.188 0.188 5.15 2.5.0 User Guide VMware OVA 10.2.1 1.46.5 1.46.5 1.14.2 5 5 38 38 0.188 0.188 0.188 0.188 5.15 2.5.0 AL2023 package list comparison for the standard AMI and VMware OVA image 379 Amazon Linux 2023 Package file file-libs filesystem findutils fonts-srpm-macros fstrm fuse3 fuse3-libs fuse-common fuse-libs gawk gdbm-libs gdisk gettext gettext-libs ghc-srpm-macros glib2 glibc glibc-all-langpacks glibc-common AMI 5.39 5.39 3.14 4.8.0 2.0.5 0.6.1 2.9.9 5.1.0 1.19 1.0.8 0.21 0.21 1.5.0 2.74.7 2.34 2.34 2.34 User Guide VMware OVA 5.39 5.39 3.14 4.8.0 2.0.5 0.6.1 3.10.4 3.10.4 3.10.4 2.9.9 5.1.0 1.19 1.0.8 0.21 0.21 1.5.0 2.74.7 2.34 2.34 2.34 AL2023 package list comparison for the standard AMI and VMware OVA image 380 Amazon Linux 2023 Package glibc-gconv-extra glibc-locale-source gmp gnupg2-minimal gnutls go-srpm-macros gpgme gpm-libs grep groff-base grub2-common grub2-efi-x64-ec2 grub2-pc grub2-pc-modules grub2-tools grub2-tools-minimal grubby gssproxy
al2023-ug-081	al2023-ug.pdf	81	Linux 2023 Package file file-libs filesystem findutils fonts-srpm-macros fstrm fuse3 fuse3-libs fuse-common fuse-libs gawk gdbm-libs gdisk gettext gettext-libs ghc-srpm-macros glib2 glibc glibc-all-langpacks glibc-common AMI 5.39 5.39 3.14 4.8.0 2.0.5 0.6.1 2.9.9 5.1.0 1.19 1.0.8 0.21 0.21 1.5.0 2.74.7 2.34 2.34 2.34 User Guide VMware OVA 5.39 5.39 3.14 4.8.0 2.0.5 0.6.1 3.10.4 3.10.4 3.10.4 2.9.9 5.1.0 1.19 1.0.8 0.21 0.21 1.5.0 2.74.7 2.34 2.34 2.34 AL2023 package list comparison for the standard AMI and VMware OVA image 380 Amazon Linux 2023 Package glibc-gconv-extra glibc-locale-source gmp gnupg2-minimal gnutls go-srpm-macros gpgme gpm-libs grep groff-base grub2-common grub2-efi-x64-ec2 grub2-pc grub2-pc-modules grub2-tools grub2-tools-minimal grubby gssproxy gzip hostname AMI 2.34 2.34 6.2.1 2.3.7 3.8.0 3.2.0 1.15.1 1.20.7 3.8 1.22.4 2.06 2.06 2.06 2.06 2.06 8.40 0.8.4 1.12 3.23 User Guide VMware OVA 2.34 2.34 6.2.1 2.3.7 3.8.0 3.2.0 1.15.1 1.20.7 3.8 1.22.4 2.06 2.06 2.06 2.06 2.06 2.06 8.40 0.8.4 1.12 3.23 AL2023 package list comparison for the standard AMI and VMware OVA image 381 Amazon Linux 2023 Package hunspell AMI 1.7.0 VMware OVA 1.7.0 User Guide hunspell-en 0.20140811.1 0.20140811.1 hunspell-en-GB 0.20140811.1 0.20140811.1 hunspell-en-US 0.20140811.1 0.20140811.1 hunspell-filesystem 1.7.0 hwdata info inih initscripts iproute iputils irqbalance jansson jemalloc jitterentropy jq json-c kbd kbd-misc kernel 0.384 6.7 49 10.09 6.10.0 1.7.0 0.384 6.7 49 10.09 6.10.0 20210202 20210202 1.9.0 2.14 5.2.1 3.4.1 1.7.1 0.14 2.4.0 2.4.0 1.9.0 2.14 5.2.1 3.4.1 0.14 2.4.0 2.4.0 6.1.112 6.1.112 AL2023 package list comparison for the standard AMI and VMware OVA image 382 Amazon Linux 2023 Package kernel-libbpf kernel-livepatch-r epo-cdn AMI 6.1.112 kernel-livepatch-r 2023.6.20241031 epo-s3 kernel-modules-extra kernel-modules-ext ra-common kernel-srpm-macros 1.0 kernel-tools 6.1.112 keyutils keyutils-libs kmod kmod-libs kpatch-runtime krb5-libs less libacl libaio libarchive libargon2 1.6.3 1.6.3 29 29 0.9.7 1.21.3 608 2.3.1 0.3.111 3.7.4 User Guide VMware OVA 6.1.112 2023.6.20241031 6.1.112 6.1.112 1.0 6.1.112 1.6.3 1.6.3 29 29 0.9.7 1.21.3 608 2.3.1 0.3.111 3.7.4 20171227 20171227 AL2023 package list comparison for the standard AMI and VMware OVA image 383 Amazon Linux 2023 Package libassuan libattr libbasicobjects libblkid libcap libcap-ng libcbor libcollection libcom_err libcomps libconfig libcurl-minimal libdb libdhash libdnf libeconf libedit libev libevent libfdisk AMI 2.5.5 2.5.1 0.1.1 2.37.4 2.48 0.8.2 0.7.0 0.7.0 1.46.5 0.1.20 1.7.2 8.5.0 5.3.28 0.5.0 0.69.0 0.4.0 3.1 4.33 2.1.12 2.37.4 User Guide VMware OVA 2.5.5 2.5.1 0.1.1 2.37.4 2.48 0.8.2 0.7.0 0.7.0 1.46.5 0.1.20 1.7.2 8.5.0 5.3.28 0.69.0 0.4.0 3.1 4.33 2.1.12 2.37.4 AL2023 package list comparison for the standard AMI and VMware OVA image 384 Amazon Linux 2023 Package libffi libfido2 libgcc libgcrypt libgomp libgpg-error libibverbs libidn2 libini_config libkcapi libkcapi-hmaccalc libldb libmaxminddb libmetalink libmnl libmodulemd libmount libmspack libnfsidmap libnghttp2 AMI 3.4.4 1.10.0 11.4.1 1.10.2 11.4.1 1.42 48.0 2.3.2 1.3.1 1.4.0 1.4.0 2.6.2 1.5.2 0.1.3 1.0.4 2.13.0 2.37.4 2.5.4 1.59.0 User Guide VMware OVA 3.4.4 1.10.0 11.4.1 1.10.2 11.4.1 1.42 48.0 2.3.2 1.3.1 1.4.0 1.4.0 1.5.2 0.1.3 1.0.4 2.13.0 2.37.4 0.10.1 2.5.4 1.59.0 AL2023 package list comparison for the standard AMI and VMware OVA image 385 Amazon Linux 2023 Package libnl3 libpath_utils libpcap libpipeline libpkgconf libpsl libpwquality libref_array librepo AMI 3.5.0 0.2.1 1.10.1 1.5.3 1.8.0 0.21.1 1.4.4 0.1.5 1.14.5 libreport-filesystem 2.15.2 libseccomp libselinux libselinux-utils libsemanage libsepol libsigsegv libsmartcols libsolv libss libsss_certmap 2.5.3 3.4 3.4 3.4 3.4 2.13 2.37.4 0.7.22 1.46.5 2.9.4 User Guide VMware OVA 3.5.0 0.2.1 1.10.1 1.5.3 1.8.0 0.21.1 1.4.4 0.1.5 1.14.5 2.15.2 2.5.3 3.4 3.4 3.4 3.4 2.13 2.37.4 0.7.22 1.46.5 AL2023 package list comparison for the standard AMI and VMware OVA image 386 Amazon Linux 2023 Package libsss_idmap libsss_nss_idmap libsss_sudo libstdc++ libstoragemgmt libtalloc libtasn1 libtdb libtevent libtextstyle libtirpc libtool-ltdl libunistring libuser libutempter libuuid libuv libverto libverto-libev libxcrypt AMI 2.9.4 2.9.4 2.9.4 11.4.1 1.9.4 2.3.4 4.19.0 1.4.7 0.13.0 0.21 1.3.3 0.9.10 0.63 1.2.1 2.37.4 1.47.0 0.3.2 0.3.2 4.4.33 User Guide VMware OVA 2.9.4 2.9.4 11.4.1 1.9.4 4.19.0 0.21 1.3.3 2.4.7 0.9.10 0.63 1.2.1 2.37.4 1.47.0 0.3.2 0.3.2 4.4.33 AL2023 package list comparison for the standard AMI and VMware OVA image 387 Amazon Linux 2023 User Guide Package libxml2 libxslt libyaml libzstd AMI 2.10.4 0.2.5 1.5.5 VMware OVA 2.10.4 1.1.34 0.2.5 1.5.5 linux-firmware-whe 20210208 20210208 nce lm_sensors-libs lmdb-libs logrotate lsof lua-libs lua-srpm-macros lz4-libs man-db man-pages microcode_ctl mpfr nano ncurses ncurses-base ncurses-libs 3.6.0 0.9.29 3.20.1 4.94.0 5.4.4 1 1.9.4 2.9.3 5.10 2.1 4.1.0 5.8 6.2 6.2 6.2 3.6.0 0.9.29 3.20.1 4.94.0 5.4.4 1 1.9.4 2.9.3 5.10 2.1 4.1.0 5.8 6.2 6.2 6.2 AL2023 package list comparison for the standard AMI and VMware OVA image 388 User Guide AMI 3.8 2.0 VMware OVA 3.8 2.0 0.52.21 0.52.21 Amazon Linux 2023 Package nettle net-tools newt nfs-utils npth nspr nss nss-softokn nss-softokn-freebl nss-sysinit nss-util ntsysv numactl-libs 2.5.4 1.6 4.35.0 3.90.0 3.90.0 3.90.0 3.90.0 3.90.0 1.15 2.0.14 ocaml-srpm-macros 6 oniguruma 6.9.7.1 openblas-srpm-macros 2 openldap openssh openssh-clients openssh-server 2.4.57 8.7p1 8.7p1 8.7p1 2.5.4 1.6 4.35.0 3.90.0 3.90.0 3.90.0 3.90.0 3.90.0 1.15 2.0.14 6 2 2.4.57 8.7p1 8.7p1 8.7p1 AL2023 package list comparison for the standard AMI and VMware OVA image 389 Amazon Linux 2023
al2023-ug-082	al2023-ug.pdf	82	6.2 6.2 6.2 AL2023 package list comparison for the standard AMI and VMware OVA image 388 User Guide AMI 3.8 2.0 VMware OVA 3.8 2.0 0.52.21 0.52.21 Amazon Linux 2023 Package nettle net-tools newt nfs-utils npth nspr nss nss-softokn nss-softokn-freebl nss-sysinit nss-util ntsysv numactl-libs 2.5.4 1.6 4.35.0 3.90.0 3.90.0 3.90.0 3.90.0 3.90.0 1.15 2.0.14 ocaml-srpm-macros 6 oniguruma 6.9.7.1 openblas-srpm-macros 2 openldap openssh openssh-clients openssh-server 2.4.57 8.7p1 8.7p1 8.7p1 2.5.4 1.6 4.35.0 3.90.0 3.90.0 3.90.0 3.90.0 3.90.0 1.15 2.0.14 6 2 2.4.57 8.7p1 8.7p1 8.7p1 AL2023 package list comparison for the standard AMI and VMware OVA image 389 Amazon Linux 2023 Package openssl openssl-libs AMI 3.0.8 3.0.8 openssl-pkcs11 0.4.12 open-vm-tools os-prober p11-kit p11-kit-trust 1.77 0.24.1 0.24.1 package-notes-srpm- 0.4 macros pam parted passwd pciutils pciutils-libs pcre2 pcre2-syntax perl-Carp perl-Class-Struct perl-constant perl-DynaLoader perl-Encode 1.5.1 3.4 0.80 3.7.0 3.7.0 10.40 10.40 1.50 0.66 1.33 1.47 3.15 User Guide VMware OVA 3.0.8 3.0.8 0.4.12 12.3.0 1.77 0.24.1 0.24.1 0.4 1.5.1 3.4 0.80 3.7.0 3.7.0 10.40 10.40 1.50 0.66 1.33 1.47 3.15 AL2023 package list comparison for the standard AMI and VMware OVA image 390 Amazon Linux 2023 Package perl-Errno perl-Exporter perl-Fcntl perl-File-Basename perl-File-Path perl-File-stat AMI 1.30 5.74 1.13 2.85 2.18 1.09 User Guide VMware OVA 1.30 5.74 1.13 2.85 2.18 1.09 perl-File-Temp 0.231.100 0.231.100 perl-Getopt-Long perl-Getopt-Std perl-HTTP-Tiny 2.52 1.12 0.078 2.52 1.12 0.078 perl-if 0.60.800 0.60.800 perl-interpreter 5.32.1 perl-IO perl-IPC-Open3 perl-libs perl-MIME-Base64 perl-mro perl-overload perl-overloading 1.43 1.21 5.32.1 3.16 1.23 1.31 0.02 perl-parent 0.238 5.32.1 1.43 1.21 5.32.1 3.16 1.23 1.31 0.02 0.238 AL2023 package list comparison for the standard AMI and VMware OVA image 391 Amazon Linux 2023 Package perl-PathTools perl-Pod-Escapes perl-podlators AMI 3.78 1.07 4.14 User Guide VMware OVA 3.78 1.07 4.14 perl-Pod-Perldoc 3.28.01 3.28.01 perl-Pod-Simple perl-Pod-Usage perl-POSIX perl-Scalar-List-U tils perl-SelectSaver perl-Socket perl-srpm-macros perl-Storable perl-subs perl-Symbol perl-Term-ANSIColor perl-Term-Cap perl-Text-ParseWords 3.42 2.01 1.94 1.56 1.02 2.032 1 3.21 1.03 1.08 5.01 1.17 3.30 3.42 2.01 1.94 1.56 1.02 2.032 1 3.21 1.03 1.08 5.01 1.17 3.30 perl-Text-Tabs+Wrap 2021.0726 2021.0726 perl-Time-Local perl-vars 1.300 1.05 1.300 1.05 AL2023 package list comparison for the standard AMI and VMware OVA image 392 Amazon Linux 2023 Package pkgconf pkgconf-m4 pkgconf-pkg-config policycoreutils policycoreutils-py thon-utils popt procps-ng protobuf-c psacct psmisc AMI 1.8.0 1.8.0 1.8.0 3.4 3.4 1.18 3.3.17 1.4.1 6.6.4 23.4 User Guide VMware OVA 1.8.0 1.8.0 1.8.0 3.4 1.18 3.3.17 1.4.1 6.6.4 23.4 publicsuffix-list- 20240212 20240212 dafsa python3 python3-attrs python3-audit 3.9.16 20.3.0 3.0.6 python3-awscrt 0.19.19 python3-babel python3-cffi python3-chardet python3-colorama 2.9.1 1.14.5 4.0.0 0.4.4 3.9.16 20.3.0 3.0.6 0.19.19 2.9.1 1.14.5 4.0.0 0.4.4 AL2023 package list comparison for the standard AMI and VMware OVA image 393 Amazon Linux 2023 Package python3-configobj AMI 5.0.6 python3-cryptography 36.0.1 python3-daemon python3-dateutil python3-dbus python3-distro python3-dnf 2.3.0 2.8.1 1.2.18 1.5.0 4.14.0 python3-dnf-plugins- 4.3.0 core python3-docutils python3-gpg python3-hawkey python3-idna python3-jinja2 python3-jmespath python3-jsonpatch python3-jsonpointer python3-jsonschema python3-libcomps python3-libdnf python3-libs 0.16 1.15.1 0.69.0 2.10 2.11.3 0.10.0 1.21 2.0 3.2.0 0.1.20 0.69.0 3.9.16 User Guide VMware OVA 5.0.6 36.0.1 2.8.1 1.2.18 1.5.0 4.14.0 4.3.0 0.16 1.15.1 0.69.0 2.10 2.11.3 0.10.0 1.21 2.0 3.2.0 0.1.20 0.69.0 3.9.16 AL2023 package list comparison for the standard AMI and VMware OVA image 394 Amazon Linux 2023 Package python3-libselinux python3-libsemanage AMI 3.4 3.4 python3-libstorage 1.9.4 mgmt python3-lockfile 0.12.2 python3-markupsafe 1.1.1 python3-netifaces python3-oauthlib python3-pip-wheel python3-ply python3-policycore utils 0.10.6 3.0.2 21.3.1 3.11 3.4 python3-prettytable 0.7.2 python3-prompt-too 3.0.24 lkit python3-pycparser 2.20 python3-pyrsistent 0.17.3 python3-pyserial python3-pysocks 3.4 1.7.1 User Guide VMware OVA 3.4 3.4 1.9.4 1.1.1 0.10.6 3.0.2 21.3.1 3.11 3.4 0.7.2 3.0.24 2.20 0.17.3 3.4 1.7.1 python3-pytz 2022.7.1 python3-pyyaml 5.4.1 2022.7.1 5.4.1 AL2023 package list comparison for the standard AMI and VMware OVA image 395 Amazon Linux 2023 Package python3-requests python3-rpm AMI 2.25.1 4.16.1.3 python3-ruamel-yaml 0.16.6 python3-ruamel-yaml- 0.1.2 clib python3-setools 4.4.1 python3-setuptools 59.6.0 python3-setuptools- 59.6.0 wheel python3-six python3-systemd 1.15.0 235 python3-urllib3 1.25.10 python3-wcwidth python-chevron python-srpm-macros quota quota-nls readline rng-tools rootfiles rpcbind 0.2.5 0.13.1 3.9 4.06 4.06 8.1 6.14 8.1 1.2.6 User Guide VMware OVA 2.25.1 4.16.1.3 0.16.6 0.1.2 4.4.1 59.6.0 59.6.0 1.15.0 235 1.25.10 0.2.5 3.9 4.06 4.06 8.1 6.14 8.1 1.2.6 AL2023 package list comparison for the standard AMI and VMware OVA image 396 Amazon Linux 2023 Package rpm rpm-build-libs rpm-libs AMI 4.16.1.3 4.16.1.3 4.16.1.3 rpm-plugin-selinux 4.16.1.3 rpm-plugin-systemd- 4.16.1.3 inhibit rpm-sign-libs 4.16.1.3 rsync rust-srpm-macros sbsigntools screen sed 3.2.6 21 0.9.4 4.8.0 4.8 selinux-policy 38.1.45 selinux-policy-tar 38.1.45 geted setup shadow-utils slang sqlite-libs sssd-client sssd-common 2.13.7 4.9 2.3.2 3.40.0 2.9.4 2.9.4 User Guide VMware OVA 4.16.1.3 4.16.1.3 4.16.1.3 4.16.1.3 4.16.1.3 4.16.1.3 3.2.6 21 0.9.4 4.8.0 4.8 38.1.45 38.1.45 2.13.7 4.9 2.3.2 3.40.0 2.9.4 AL2023 package list comparison for the standard AMI and VMware OVA image 397 Amazon Linux 2023 Package sssd-kcm sssd-nfs-idmap strace sudo sysctl-defaults sysstat systemd systemd-libs systemd-networkd systemd-pam systemd-resolved systemd-udev AMI 2.9.4 2.9.4 6.8 1.9.15 1.0 12.5.6 252.23 252.23 252.23 252.23 252.23 252.23 User Guide VMware OVA 6.8 1.9.15 1.0 12.5.6 252.23 252.23 252.23 252.23 252.23 252.23 system-release 2023.6.20241031 2023.6.20241031 systemtap-runtime tar tbb tcpdump tcsh time traceroute 4.8 1.34 2020.3
al2023-ug-083	al2023-ug.pdf	83	sqlite-libs sssd-client sssd-common 2.13.7 4.9 2.3.2 3.40.0 2.9.4 2.9.4 User Guide VMware OVA 4.16.1.3 4.16.1.3 4.16.1.3 4.16.1.3 4.16.1.3 4.16.1.3 3.2.6 21 0.9.4 4.8.0 4.8 38.1.45 38.1.45 2.13.7 4.9 2.3.2 3.40.0 2.9.4 AL2023 package list comparison for the standard AMI and VMware OVA image 397 Amazon Linux 2023 Package sssd-kcm sssd-nfs-idmap strace sudo sysctl-defaults sysstat systemd systemd-libs systemd-networkd systemd-pam systemd-resolved systemd-udev AMI 2.9.4 2.9.4 6.8 1.9.15 1.0 12.5.6 252.23 252.23 252.23 252.23 252.23 252.23 User Guide VMware OVA 6.8 1.9.15 1.0 12.5.6 252.23 252.23 252.23 252.23 252.23 252.23 system-release 2023.6.20241031 2023.6.20241031 systemtap-runtime tar tbb tcpdump tcsh time traceroute 4.8 1.34 2020.3 4.99.1 6.24.07 1.9 2.1.3 4.8 1.34 2020.3 4.99.1 6.24.07 1.9 2.1.3 AL2023 package list comparison for the standard AMI and VMware OVA image 398 Amazon Linux 2023 Package tzdata unzip update-motd userspace-rcu util-linux util-linux-core vim-common vim-data vim-enhanced vim-filesystem vim-minimal wget which words xfsdump xfsprogs xmlsec1 xmlsec1-openssl xxd xxhash-libs AMI 2024a 6.0 2.2 0.12.1 2.37.4 2.37.4 9.0.2153 9.0.2153 9.0.2153 9.0.2153 9.0.2153 1.21.3 2.21 3.0 3.1.11 5.18.0 9.0.2153 0.8.0 User Guide VMware OVA 2024a 6.0 2.2 0.12.1 2.37.4 2.37.4 9.0.2153 9.0.2153 9.0.2153 9.0.2153 9.0.2153 1.21.3 2.21 3.0 3.1.11 5.18.0 1.2.33 1.2.33 9.0.2153 0.8.0 AL2023 package list comparison for the standard AMI and VMware OVA image 399 Amazon Linux 2023 User Guide Package xz xz-libs yum zip zlib zram-generator zram-generator-def aults zstd AMI 5.2.5 5.2.5 4.14.0 3.0 1.2.11 1.1.2 1.1.2 1.5.5 VMware OVA 5.2.5 5.2.5 4.14.0 3.0 1.2.11 1.5.5 Comparing packages installed on Amazon Linux 2023 standard AMI with the AL2023 Hyper-V image A comparison of the RPMs present on the AL2023 standard AMI compared with the RPMs present on the AL2023 Hyper-V image. Package acl acpid alternatives AMI 2.3.1 2.0.32 1.15 amazon-chrony-config 4.3 amazon-ec2-net-utils 2.4.1 amazon-linux-onprem Hyper-V VHDX 2.3.1 1.15 1.2 AL2023 package list comparison for the standard AMI and Hyper-V image 400 Amazon Linux 2023 User Guide Package AMI Hyper-V VHDX amazon-linux-repo- cdn 2023.4.20240319 amazon-linux-repo-s3 2023.4.20240319 amazon-linux-sb-keys 2023.1 amazon-onprem-netw ork amazon-rpm-config 228 2023.1 1.2 228 amazon-ssm-agent 3.2.2303.0 3.2.2303.0 at attr audit audit-libs aws-cfn-bootstrap awscli-2 basesystem bash bash-completion bc bind-libs bind-license bind-utils 3.1.23 2.5.1 3.0.6 3.0.6 2.0 2.14.5 11 5.2.15 2.11 1.07.1 9.16.48 9.16.48 9.16.48 3.1.23 2.5.1 3.0.6 3.0.6 2.14.5 11 5.2.15 2.11 1.07.1 9.16.48 9.16.48 9.16.48 AL2023 package list comparison for the standard AMI and Hyper-V image 401 Amazon Linux 2023 Package binutils boost-filesystem boost-system boost-thread bzip2 bzip2-libs AMI 2.39 1.75.0 1.75.0 1.75.0 1.0.8 1.0.8 User Guide Hyper-V VHDX 2.39 1.75.0 1.75.0 1.75.0 1.0.8 1.0.8 ca-certificates 2023.2.64 2023.2.64 c-ares checkpolicy chkconfig chrony cloud-init cloud-init-cfg-ec2 cloud-init-cfg-onp rem cloud-utils-growpart coreutils coreutils-common cpio cracklib cracklib-dicts 1.19.0 3.4 1.15 4.3 22.2.2 22.2.2 0.31 8.32 8.32 2.13 2.9.6 2.9.6 3.4 1.15 4.3 22.2.2 22.2.2 0.31 8.32 8.32 2.13 2.9.6 2.9.6 AL2023 package list comparison for the standard AMI and Hyper-V image 402 Amazon Linux 2023 Package crontabs AMI 1.11 crypto-policies 20220428 crypto-policies-sc 20220428 User Guide Hyper-V VHDX 1.11 20220428 20220428 ripts cryptsetup cryptsetup-libs curl-minimal cyrus-sasl-lib cyrus-sasl-plain dbus dbus-broker dbus-common dbus-libs 2.6.1 2.6.1 8.5.0 2.1.27 2.1.27 1.12.28 32 1.12.28 1.12.28 device-mapper 1.02.185 device-mapper-libs 1.02.185 diffutils dnf dnf-data 3.8 4.14.0 4.14.0 dnf-plugin-release- 1.2 notification dnf-plugins-core 4.3.0 2.6.1 2.6.1 8.5.0 2.1.27 2.1.27 1.12.28 32 1.12.28 1.12.28 1.02.185 1.02.185 3.8 4.14.0 4.14.0 1.2 4.3.0 AL2023 package list comparison for the standard AMI and Hyper-V image 403 Amazon Linux 2023 Package dnf-plugin-support- info dnf-utils dosfstools dracut dracut-config-ec2 dracut-config-gene ric dwz dyninst e2fsprogs e2fsprogs-libs ec2-hibinit-agent ec2-instance-connect ec2-instance-conne ct-selinux ec2-utils ed efi-filesystem efi-srpm-macros efivar AMI 1.2 4.3.0 4.2 055 3.0 055 0.14 10.2.1 1.46.5 1.46.5 1.0.8 1.1 1.1 2.2.0 1.14.2 5 5 38 User Guide Hyper-V VHDX 1.2 4.3.0 4.2 055 055 0.14 10.2.1 1.46.5 1.46.5 1.14.2 5 5 38 AL2023 package list comparison for the standard AMI and Hyper-V image 404 Amazon Linux 2023 Package efivar-libs AMI 38 elfutils-debuginfod- 0.188 client elfutils-default-y 0.188 ama-scope elfutils-libelf elfutils-libs ethtool expat file file-libs filesystem findutils fonts-srpm-macros fstrm fuse-libs gawk gdbm-libs gdisk gettext gettext-libs 0.188 0.188 5.15 2.5.0 5.39 5.39 3.14 4.8.0 2.0.5 0.6.1 2.9.9 5.1.0 1.19 1.0.8 0.21 0.21 User Guide Hyper-V VHDX 38 0.188 0.188 0.188 0.188 5.15 2.5.0 5.39 5.39 3.14 4.8.0 2.0.5 0.6.1 2.9.9 5.1.0 1.19 1.0.8 0.21 0.21 AL2023 package list comparison for the standard AMI and Hyper-V image 405 Amazon Linux 2023 Package ghc-srpm-macros glib2 glibc glibc-all-langpacks glibc-common glibc-gconv-extra glibc-locale-source gmp gnupg2-minimal gnutls go-srpm-macros gpgme gpm-libs grep groff-base grub2-common grub2-efi-x64-ec2 grub2-pc grub2-pc-modules grub2-tools AMI 1.5.0 2.74.7 2.34 2.34 2.34 2.34 2.34 6.2.1 2.3.7 3.8.0 3.2.0 1.15.1 1.20.7 3.8 1.22.4 2.06 2.06 2.06 2.06 User Guide Hyper-V VHDX 1.5.0 2.74.7 2.34 2.34 2.34 2.34 2.34 6.2.1 2.3.7 3.8.0 3.2.0 1.15.1 1.20.7 3.8 1.22.4 2.06 2.06 2.06 2.06 2.06 AL2023 package list comparison for the standard AMI and Hyper-V image 406 Amazon Linux 2023 Package grub2-tools-minimal grubby gssproxy gzip hostname hunspell AMI 2.06 8.40 0.8.4 1.12 3.23 1.7.0 User Guide Hyper-V VHDX 2.06 8.40 0.8.4 1.12 3.23 1.7.0 hunspell-en 0.20140811.1 0.20140811.1 hunspell-en-GB
al2023-ug-084	al2023-ug.pdf	84	gmp gnupg2-minimal gnutls go-srpm-macros gpgme gpm-libs grep groff-base grub2-common grub2-efi-x64-ec2 grub2-pc grub2-pc-modules grub2-tools AMI 1.5.0 2.74.7 2.34 2.34 2.34 2.34 2.34 6.2.1 2.3.7 3.8.0 3.2.0 1.15.1 1.20.7 3.8 1.22.4 2.06 2.06 2.06 2.06 User Guide Hyper-V VHDX 1.5.0 2.74.7 2.34 2.34 2.34 2.34 2.34 6.2.1 2.3.7 3.8.0 3.2.0 1.15.1 1.20.7 3.8 1.22.4 2.06 2.06 2.06 2.06 2.06 AL2023 package list comparison for the standard AMI and Hyper-V image 406 Amazon Linux 2023 Package grub2-tools-minimal grubby gssproxy gzip hostname hunspell AMI 2.06 8.40 0.8.4 1.12 3.23 1.7.0 User Guide Hyper-V VHDX 2.06 8.40 0.8.4 1.12 3.23 1.7.0 hunspell-en 0.20140811.1 0.20140811.1 hunspell-en-GB 0.20140811.1 0.20140811.1 hunspell-en-US 0.20140811.1 0.20140811.1 hunspell-filesystem 1.7.0 hwdata 0.353 hyperv-daemons hyperv-daemons-lic ense hypervfcopyd hypervkvpd hyperv-tools hypervvssd info inih initscripts 6.7 49 10.09 1.7.0 0.353 0 0 0 0 0 0 6.7 49 10.09 AL2023 package list comparison for the standard AMI and Hyper-V image 407 Amazon Linux 2023 Package iproute iputils irqbalance jansson jitterentropy jq json-c kbd kbd-misc kernel kernel-livepatch-r epo-cdn AMI 5.10.0 20210202 1.9.0 2.14 3.4.1 1.7.1 0.14 2.4.0 2.4.0 User Guide Hyper-V VHDX 5.10.0 20210202 1.9.0 2.14 3.4.1 1.7.1 0.14 2.4.0 2.4.0 6.1.79 6.1.79 2023.4.20240319 kernel-livepatch-r 2023.4.20240319 epo-s3 kernel-modules-extra kernel-modules-ext ra-common kernel-srpm-macros 1.0 kernel-tools keyutils keyutils-libs 6.1.79 1.6.3 1.6.3 6.1.79 6.1.79 1.0 6.1.79 1.6.3 1.6.3 AL2023 package list comparison for the standard AMI and Hyper-V image 408 Amazon Linux 2023 Package kmod kmod-libs kpatch-runtime krb5-libs less libacl libaio libarchive libargon2 libassuan libattr libbasicobjects libblkid libcap libcap-ng libcbor libcollection libcom_err libcomps libconfig AMI 29 29 0.9.7 1.21 608 2.3.1 0.3.111 3.5.3 User Guide Hyper-V VHDX 29 29 0.9.7 1.21 608 2.3.1 0.3.111 3.5.3 20171227 20171227 2.5.5 2.5.1 0.1.1 2.37.4 2.48 0.8.2 0.7.0 0.7.0 1.46.5 0.1.20 1.7.2 2.5.5 2.5.1 0.1.1 2.37.4 2.48 0.8.2 0.7.0 0.7.0 1.46.5 0.1.20 1.7.2 AL2023 package list comparison for the standard AMI and Hyper-V image 409 Amazon Linux 2023 Package libcurl-minimal libdb libdhash libdnf libeconf libedit libev libevent libfdisk libffi libfido2 libgcc libgcrypt libgomp libgpg-error libibverbs libidn2 libini_config libkcapi libkcapi-hmaccalc AMI 8.5.0 5.3.28 0.5.0 0.69.0 0.4.0 3.1 4.33 2.1.12 2.37.4 3.4.4 1.10.0 11.4.1 1.10.2 11.4.1 1.42 48.0 2.3.2 1.3.1 1.4.0 1.4.0 User Guide Hyper-V VHDX 8.5.0 5.3.28 0.69.0 0.4.0 3.1 4.33 2.1.12 2.37.4 3.4.4 1.10.0 11.4.1 1.10.2 11.4.1 1.42 48.0 2.3.2 1.3.1 1.4.0 1.4.0 AL2023 package list comparison for the standard AMI and Hyper-V image 410 Amazon Linux 2023 Package libldb libmaxminddb libmetalink libmnl libmodulemd libmount libnfsidmap libnghttp2 libnl3 libpath_utils libpcap libpipeline libpkgconf libpsl libpwquality libref_array librepo AMI 2.6.2 1.5.2 0.1.3 1.0.4 2.13.0 2.37.4 2.5.4 1.57.0 3.5.0 0.2.1 1.10.1 1.5.3 1.8.0 0.21.1 1.4.4 0.1.5 1.14.5 libreport-filesystem 2.15.2 libseccomp libselinux 2.5.3 3.4 User Guide Hyper-V VHDX 1.5.2 0.1.3 1.0.4 2.13.0 2.37.4 2.5.4 1.57.0 3.5.0 0.2.1 1.10.1 1.5.3 1.8.0 0.21.1 1.4.4 0.1.5 1.14.5 2.15.2 2.5.3 3.4 AL2023 package list comparison for the standard AMI and Hyper-V image 411 Amazon Linux 2023 Package libselinux-utils libsemanage libsepol libsigsegv libsmartcols libsolv libss libsss_certmap libsss_idmap libsss_nss_idmap libsss_sudo libstdc++ libstoragemgmt libtalloc libtasn1 libtdb libtevent libtextstyle libtirpc libunistring AMI 3.4 3.4 3.4 2.13 2.37.4 0.7.22 1.46.5 2.9.4 2.9.4 2.9.4 2.9.4 11.4.1 1.9.4 2.3.4 4.19.0 1.4.7 0.13.0 0.21 1.3.3 0.9.10 User Guide Hyper-V VHDX 3.4 3.4 3.4 2.13 2.37.4 0.7.22 1.46.5 2.9.4 2.9.4 11.4.1 1.9.4 4.19.0 0.21 1.3.3 0.9.10 AL2023 package list comparison for the standard AMI and Hyper-V image 412 Amazon Linux 2023 Package libuser libutempter libuuid libuv libverto libverto-libev libxcrypt libxml2 libyaml libzstd lm_sensors-libs lmdb-libs logrotate lsof lua-libs lua-srpm-macros lz4-libs man-db man-pages microcode_ctl AMI 0.63 1.2.1 2.37.4 1.47.0 0.3.2 0.3.2 4.4.33 2.10.4 0.2.5 1.5.5 3.6.0 0.9.29 3.20.1 4.94.0 5.4.4 1 1.9.4 2.9.3 5.10 2.1 User Guide Hyper-V VHDX 0.63 1.2.1 2.37.4 1.47.0 0.3.2 0.3.2 4.4.33 2.10.4 0.2.5 1.5.5 3.6.0 0.9.29 3.20.1 4.94.0 5.4.4 1 1.9.4 2.9.3 5.10 2.1 AL2023 package list comparison for the standard AMI and Hyper-V image 413 Amazon Linux 2023 User Guide AMI 4.1.0 5.8 6.2 6.2 6.2 3.8 2.0 Hyper-V VHDX 4.1.0 5.8 6.2 6.2 6.2 3.8 2.0 0.52.21 0.52.21 Package mpfr nano ncurses ncurses-base ncurses-libs nettle net-tools newt nfs-utils npth nspr nss nss-softokn nss-softokn-freebl nss-sysinit nss-util ntsysv numactl-libs 2.5.4 1.6 4.35.0 3.90.0 3.90.0 3.90.0 3.90.0 3.90.0 1.15 2.0.14 ocaml-srpm-macros 6 oniguruma 6.9.7.1 2.5.4 1.6 4.35.0 3.90.0 3.90.0 3.90.0 3.90.0 3.90.0 1.15 2.0.14 6 6.9.7.1 AL2023 package list comparison for the standard AMI and Hyper-V image 414 Amazon Linux 2023 User Guide Package AMI Hyper-V VHDX openblas-srpm-macros 2 openldap openssh openssh-clients openssh-server openssl openssl-libs openssl-pkcs11 os-prober p11-kit p11-kit-trust 2.4.57 8.7p1 8.7p1 8.7p1 3.0.8 3.0.8 0.4.12 1.77 0.24.1 0.24.1 package-notes-srpm- 0.4 macros pam parted passwd pciutils pciutils-libs pcre2 pcre2-syntax perl-Carp 1.5.1 3.4 0.80 3.7.0 3.7.0 10.40 10.40 1.50 2 2.4.57 8.7p1 8.7p1 8.7p1 3.0.8 3.0.8 0.4.12 1.77 0.24.1 0.24.1 0.4 1.5.1 3.4 0.80 3.7.0 3.7.0 10.40 10.40 1.50 AL2023 package list comparison for the standard AMI and Hyper-V image 415 Amazon Linux 2023 Package perl-Class-Struct perl-constant perl-DynaLoader perl-Encode perl-Errno perl-Exporter perl-Fcntl perl-File-Basename perl-File-Path perl-File-stat AMI 0.66 1.33 1.47 3.15 1.30
al2023-ug-085	al2023-ug.pdf	85	2023 User Guide Package AMI Hyper-V VHDX openblas-srpm-macros 2 openldap openssh openssh-clients openssh-server openssl openssl-libs openssl-pkcs11 os-prober p11-kit p11-kit-trust 2.4.57 8.7p1 8.7p1 8.7p1 3.0.8 3.0.8 0.4.12 1.77 0.24.1 0.24.1 package-notes-srpm- 0.4 macros pam parted passwd pciutils pciutils-libs pcre2 pcre2-syntax perl-Carp 1.5.1 3.4 0.80 3.7.0 3.7.0 10.40 10.40 1.50 2 2.4.57 8.7p1 8.7p1 8.7p1 3.0.8 3.0.8 0.4.12 1.77 0.24.1 0.24.1 0.4 1.5.1 3.4 0.80 3.7.0 3.7.0 10.40 10.40 1.50 AL2023 package list comparison for the standard AMI and Hyper-V image 415 Amazon Linux 2023 Package perl-Class-Struct perl-constant perl-DynaLoader perl-Encode perl-Errno perl-Exporter perl-Fcntl perl-File-Basename perl-File-Path perl-File-stat AMI 0.66 1.33 1.47 3.15 1.30 5.74 1.13 2.85 2.18 1.09 User Guide Hyper-V VHDX 0.66 1.33 1.47 3.15 1.30 5.74 1.13 2.85 2.18 1.09 perl-File-Temp 0.231.100 0.231.100 perl-Getopt-Long perl-Getopt-Std perl-HTTP-Tiny 2.52 1.12 0.078 2.52 1.12 0.078 perl-if 0.60.800 0.60.800 perl-interpreter 5.32.1 perl-IO perl-IPC-Open3 perl-libs perl-MIME-Base64 1.43 1.21 5.32.1 3.16 5.32.1 1.43 1.21 5.32.1 3.16 AL2023 package list comparison for the standard AMI and Hyper-V image 416 Amazon Linux 2023 Package perl-mro perl-overload perl-overloading perl-parent perl-PathTools perl-Pod-Escapes perl-podlators AMI 1.23 1.31 0.02 0.238 3.78 1.07 4.14 User Guide Hyper-V VHDX 1.23 1.31 0.02 0.238 3.78 1.07 4.14 perl-Pod-Perldoc 3.28.01 3.28.01 perl-Pod-Simple perl-Pod-Usage perl-POSIX perl-Scalar-List-U tils perl-SelectSaver perl-Socket perl-srpm-macros perl-Storable perl-subs perl-Symbol perl-Term-ANSIColor perl-Term-Cap 3.42 2.01 1.94 1.56 1.02 2.032 1 3.21 1.03 1.08 5.01 1.17 3.42 2.01 1.94 1.56 1.02 2.032 1 3.21 1.03 1.08 5.01 1.17 AL2023 package list comparison for the standard AMI and Hyper-V image 417 Amazon Linux 2023 Package perl-Text-ParseWords AMI 3.30 perl-Text-Tabs+Wrap 2021.0726 perl-Time-Local 1.300 perl-vars pkgconf pkgconf-m4 pkgconf-pkg-config policycoreutils policycoreutils-py thon-utils popt procps-ng protobuf-c psacct psmisc 1.05 1.8.0 1.8.0 1.8.0 3.4 3.4 1.18 3.3.17 1.4.1 6.6.4 23.4 User Guide Hyper-V VHDX 3.30 2021.0726 1.300 1.05 1.8.0 1.8.0 1.8.0 3.4 1.18 3.3.17 1.4.1 6.6.4 23.4 publicsuffix-list- 20240212 20240212 dafsa python3 python3-attrs python3-audit 3.9.16 20.3.0 3.0.6 python3-awscrt 0.19.19 3.9.16 20.3.0 3.0.6 0.19.19 AL2023 package list comparison for the standard AMI and Hyper-V image 418 Amazon Linux 2023 Package python3-babel python3-cffi python3-chardet python3-colorama python3-configobj AMI 2.9.1 1.14.5 4.0.0 0.4.4 5.0.6 python3-cryptography 36.0.1 python3-daemon python3-dateutil python3-dbus python3-distro python3-dnf 2.3.0 2.8.1 1.2.18 1.5.0 4.14.0 python3-dnf-plugins- 4.3.0 core python3-docutils python3-gpg python3-hawkey python3-idna python3-jinja2 python3-jmespath python3-jsonpatch python3-jsonpointer 0.16 1.15.1 0.69.0 2.10 2.11.3 0.10.0 1.21 2.0 User Guide Hyper-V VHDX 2.9.1 1.14.5 4.0.0 0.4.4 5.0.6 36.0.1 2.8.1 1.2.18 1.5.0 4.14.0 4.3.0 0.16 1.15.1 0.69.0 2.10 2.11.3 0.10.0 1.21 2.0 AL2023 package list comparison for the standard AMI and Hyper-V image 419 Amazon Linux 2023 Package python3-jsonschema python3-libcomps python3-libdnf python3-libs python3-libselinux python3-libsemanage AMI 3.2.0 0.1.20 0.69.0 3.9.16 3.4 3.4 python3-libstorage 1.9.4 mgmt python3-lockfile 0.12.2 python3-markupsafe 1.1.1 python3-netifaces python3-oauthlib python3-pip-wheel python3-ply python3-policycore utils 0.10.6 3.0.2 21.3.1 3.11 3.4 python3-prettytable 0.7.2 python3-prompt-too 3.0.24 lkit python3-pycparser 2.20 python3-pyrsistent 0.17.3 User Guide Hyper-V VHDX 3.2.0 0.1.20 0.69.0 3.9.16 3.4 3.4 1.9.4 1.1.1 0.10.6 3.0.2 21.3.1 3.11 3.4 0.7.2 3.0.24 2.20 0.17.3 AL2023 package list comparison for the standard AMI and Hyper-V image 420 Amazon Linux 2023 Package python3-pyserial python3-pysocks AMI 3.4 1.7.1 python3-pytz 2022.7.1 python3-pyyaml python3-requests python3-rpm 5.4.1 2.25.1 4.16.1.3 python3-ruamel-yaml 0.16.6 python3-ruamel-yaml- 0.1.2 clib python3-setools 4.4.1 python3-setuptools 59.6.0 python3-setuptools- 59.6.0 wheel python3-six python3-systemd 1.15.0 235 python3-urllib3 1.25.10 python3-wcwidth python-chevron python-srpm-macros quota quota-nls 0.2.5 0.13.1 3.9 4.06 4.06 User Guide Hyper-V VHDX 3.4 1.7.1 2022.7.1 5.4.1 2.25.1 4.16.1.3 0.16.6 0.1.2 4.4.1 59.6.0 59.6.0 1.15.0 235 1.25.10 0.2.5 3.9 4.06 4.06 AL2023 package list comparison for the standard AMI and Hyper-V image 421 Amazon Linux 2023 Package readline rng-tools rootfiles rpcbind rpm rpm-build-libs rpm-libs AMI 8.1 6.14 8.1 1.2.6 4.16.1.3 4.16.1.3 4.16.1.3 rpm-plugin-selinux 4.16.1.3 rpm-plugin-systemd- 4.16.1.3 inhibit rpm-sign-libs 4.16.1.3 rsync rust-srpm-macros sbsigntools screen sed selinux-policy selinux-policy-tar geted setup shadow-utils 3.2.6 21 0.9.4 4.8.0 4.8 37.22 37.22 2.13.7 4.9 User Guide Hyper-V VHDX 8.1 6.14 8.1 1.2.6 4.16.1.3 4.16.1.3 4.16.1.3 4.16.1.3 4.16.1.3 4.16.1.3 3.2.6 21 0.9.4 4.8.0 4.8 37.22 37.22 2.13.7 4.9 AL2023 package list comparison for the standard AMI and Hyper-V image 422 Amazon Linux 2023 Package slang sqlite-libs sssd-client sssd-common sssd-kcm sssd-nfs-idmap strace sudo sysctl-defaults sysstat systemd systemd-libs systemd-networkd systemd-pam systemd-resolved systemd-udev AMI 2.3.2 3.40.0 2.9.4 2.9.4 2.9.4 2.9.4 5.16 1.9.14 1.0 12.5.6 252.16 252.16 252.16 252.16 252.16 252.16 User Guide Hyper-V VHDX 2.3.2 3.40.0 2.9.4 5.16 1.9.14 1.0 12.5.6 252.16 252.16 252.16 252.16 252.16 252.16 system-release 2023.4.20240319 2023.4.20240319 systemtap-runtime tar tbb 4.8 1.34 2020.3 4.8 1.34 2020.3 AL2023 package list comparison for the standard AMI and Hyper-V image 423 Amazon Linux 2023 User Guide Package tcpdump tcsh time traceroute tzdata unzip update-motd userspace-rcu util-linux util-linux-core vim-common vim-data vim-enhanced vim-filesystem vim-minimal wget which words xfsdump xfsprogs AMI 4.99.1 6.24.07 1.9 2.1.3 2024a 6.0 2.2 0.12.1 2.37.4 2.37.4 9.0.2153 9.0.2153 9.0.2153 9.0.2153 9.0.2153 1.21.3 2.21 3.0 3.1.11 5.18.0 Hyper-V VHDX 4.99.1 6.24.07 1.9 2.1.3 2024a 6.0 2.2 0.12.1 2.37.4 2.37.4 9.0.2153 9.0.2153 9.0.2153 9.0.2153 9.0.2153 1.21.3 2.21 3.0 3.1.11 5.18.0 AL2023 package list comparison for the standard AMI and Hyper-V image 424 Amazon Linux
al2023-ug-086	al2023-ug.pdf	86	1.34 2020.3 4.8 1.34 2020.3 AL2023 package list comparison for the standard AMI and Hyper-V image 423 Amazon Linux 2023 User Guide Package tcpdump tcsh time traceroute tzdata unzip update-motd userspace-rcu util-linux util-linux-core vim-common vim-data vim-enhanced vim-filesystem vim-minimal wget which words xfsdump xfsprogs AMI 4.99.1 6.24.07 1.9 2.1.3 2024a 6.0 2.2 0.12.1 2.37.4 2.37.4 9.0.2153 9.0.2153 9.0.2153 9.0.2153 9.0.2153 1.21.3 2.21 3.0 3.1.11 5.18.0 Hyper-V VHDX 4.99.1 6.24.07 1.9 2.1.3 2024a 6.0 2.2 0.12.1 2.37.4 2.37.4 9.0.2153 9.0.2153 9.0.2153 9.0.2153 9.0.2153 1.21.3 2.21 3.0 3.1.11 5.18.0 AL2023 package list comparison for the standard AMI and Hyper-V image 424 Amazon Linux 2023 Package xxd xxhash-libs xz xz-libs yum zip zlib zram-generator zram-generator-def aults zstd AMI 9.0.2153 0.8.0 5.2.5 5.2.5 4.14.0 3.0 1.2.11 1.1.2 1.1.2 1.5.5 User Guide Hyper-V VHDX 9.0.2153 0.8.0 5.2.5 5.2.5 4.14.0 3.0 1.2.11 1.5.5 AL2023 package list comparison for the standard AMI and Hyper-V image 425 Amazon Linux 2023 User Guide Filesystem Layout This section covers the ﬁlesystem layout of an AL2023 system, including details that may be speciﬁc to instances or AL2023 based containers. See the file-hierarchy(7) man page for more information. Topics • / (The root directory) • /boot (Kernel, initramfs, etc.) • /etc (System Conﬁguration) • /home (User home directories) • /root (root user home directory) • /srv (Server Payload) • /tmp (small temporary ﬁles) • /run (runtime data) • /usr (System Resources) • /var (Persistent Variable System Data) / (The root directory) By default, AL2023 images are conﬁgured with a writable /, allowing privileged users to create new ﬁles and directories. It is possible to conﬁgure systemd services to use a diﬀerent path or image to appear as / for that service, as well as place access restrictions on any path. Note It is best practice for systemd services to be conﬁgured to restrict what the service has access to. This can include using the ReadOnlyPaths=/ directive which makes / read only for that service. For more information on using systemd to restrict what access a service has to the system, see the systemd.exec(5) man page. / 426 Amazon Linux 2023 User Guide /boot (Kernel, initramfs, etc.) By default, bootable AL2023 images are conﬁgured with /boot being on the root ﬁle system. The /boot path is only relevant for bootable images, so is unused in AL2023 container images. This directory is home to ﬁles needed for AL2023 to boot such as the Linux kernel and initramfs. The content of this directory should only be manipulated using the tools provided with the OS. /boot/efi (EFI System Partition) By default, bootable AL2023 images are conﬁgured with the EFI System partition being mounted at /boot/efi. This ﬁle system is managed by the OS and contains code and conﬁguration critical to booting the system. This path is not relevant for container images. /etc (System Conﬁguration) The /etc directory on AL2023 contains system-speciﬁc conﬁguration. By default, AL2023 images come with /etc on the root ﬁlesystem and writable by privileged users. Note It is common for applications (including systemd) to keep default conﬁguration under / usr (System Resources) which can be overriden by placing conﬁguration in /etc (System Conﬁguration). For these applications, changing ﬁles in /usr (System Resources) rather than overriding default conﬁguration in /etc will likely result in the changes being overriden when the package is updated. /home (User home directories) Normal users have their home directories under /home, but software should always look for the per-user $HOME environment variable rather than relying on a pattern such as /home/$USER. By default, AL2023 images have /home on the root ﬁle system, but software should not rely on this. It is perfectly valid for the OS to be conﬁgured for /home to be a separate ﬁle system, which is mounted later during boot, or only after a user authenticates to the system. /boot 427 Amazon Linux 2023 User Guide The root user home directory is not in /home but rather is /root (root user home directory) so that it is available in the event that the /home ﬁle system cannot be mounted. Note It is best practice for systemd services which do not need write access to /home to be conﬁgured with the ProtectHome=read-only directive. With this option, /home, /root, and /run/user are made read-only for the service. It is also best practice for services that do not need any access to /home to be conﬁgured with the ProtectHome=tmpfs directive, which will run the service in a sandbox where / home, /root, and /run/user are empty read-only tmpfs ﬁle systems. For more information on using systemd to restrict what access a service has to the system, see the systemd.exec(5) man page. /root (root user home directory) The home directory of the root user is the /root directory, purposefully separate from /home (User home directories) so that it is present in the
al2023-ug-087	al2023-ug.pdf	87	/run/user are made read-only for the service. It is also best practice for services that do not need any access to /home to be conﬁgured with the ProtectHome=tmpfs directive, which will run the service in a sandbox where / home, /root, and /run/user are empty read-only tmpfs ﬁle systems. For more information on using systemd to restrict what access a service has to the system, see the systemd.exec(5) man page. /root (root user home directory) The home directory of the root user is the /root directory, purposefully separate from /home (User home directories) so that it is present in the event that /home (User home directories) is on a ﬁle system which is not available. The best practice for conﬁguring systemd services is the same for /root as it is for /home (User home directories). /srv (Server Payload) The /srv directory is managed by the administrator of the system and Amazon Linux 2023 places no restrictions on how this directory is organized. It is possible to conﬁgure the /srv directory to be on a separate ﬁle system, so it may only become available later in boot. /root 428 Amazon Linux 2023 User Guide /tmp (small temporary ﬁles) Note Amazon Linux 2023 is diﬀerent to Amazon Linux 2 as by default /tmp is now tmpfs rather than a path on the root ﬁle system. Note When running in a container, it will typically be your container runtime conﬁguration that dictates if /tmp is tmpfs, or a path on disk, and if there is a running clean-up process or not. The /tmp directory is for small, size-bounded temporary ﬁles. By default, AL2023 conﬁgures it to be a tmpfs ﬁle system with a size limit of 50% of RAM and a maximum of one million inodes. Applications should prefer the path in the $TMPDIR environment variable over /tmp. Users can then set the $TMPDIR environment variable to override the path an application should use for / tmp For larger temporary ﬁles, /var/tmp should be used instead. Warning Since /tmp is shared, it is important to use safe methods of creating temporary ﬁles. For details, see the upstream systemd documentation on Using /tmp and /var/tmp Safely. Note It is best practice for systemd services to be conﬁgured with the PrivateTmp= directive set to yes or disconnected which runs the service in a sandbox where /tmp and /var/ tmp are not shared with the host or other services. For more information, including how to conﬁgure two services to share the same private temporary directories, see the systemd.exec(5) man page. /tmp 429 Amazon Linux 2023 User Guide The content of /tmp is typically cleaned at boot time, and unused ﬁles are regularly cleaned up. By default, the cleanup process runs shortly after boot and then every day. For information on how to conﬁgure the clean-up of temporary ﬁles, see the tmpfiles.d(5) and systemd-tmpfiles(8) man man pages. The /tmp and /var/tmp paths are closely related and exist for diﬀerent purposes. /run (runtime data) The /run directory is used by system packages to store small amounts of runtime data (such as socket ﬁles). It is a tmpfs ﬁle system, and is writable only by privileged programs. The /run/log directory can be used by system components to store logs in, either before being written out to /var/log or before the /var/log ﬁle system is available. The /run/user/ path contains per-user runtime directories. By default, these will be individual tmpfs ﬁle systems mounted by systemd when the user logs in, and erased when the user is no longer logged in. As per the XDG Base Directory Speciﬁcation, these paths should not be referenced directly but rather via the $XDG_RUNTIME_DIR environment variable. /usr (System Resources) The /usr hierarchy is for vendor supplied Operating System resources. Except for the /usr/local hierarchy, nothing should modify anything under /usr except the OS package manager. Software applications must assume that /usr can be read-only. The /usr hierarchy must not be used for volitile data. Except for /usr/local, the /usr hierarchy must not be used for any data that is added or changed outside of package installation/removal as done by the OS package manager. The OS package manager may assume that all of the /usr hierarchy (except /usr/ local) is the same mountpoint. Software being installed outside of the OS package manager should not store data in /usr as this may impede any future invocation of the OS package manager. The /usr/local hierarchy is the exception, and is reserved for software outside of the OS package manager. /run 430 Amazon Linux 2023 User Guide /usr/bin (Executables) Executable ﬁles which should appear in the standard search $PATH, and are useful to invoke from a shell. Daemons and executables which are not useful to invoke from a shell instead live in /usr/ lib or /usr/libexec. /usr/include (C/C++ Headers)
al2023-ug-088	al2023-ug.pdf	88	(except /usr/ local) is the same mountpoint. Software being installed outside of the OS package manager should not store data in /usr as this may impede any future invocation of the OS package manager. The /usr/local hierarchy is the exception, and is reserved for software outside of the OS package manager. /run 430 Amazon Linux 2023 User Guide /usr/bin (Executables) Executable ﬁles which should appear in the standard search $PATH, and are useful to invoke from a shell. Daemons and executables which are not useful to invoke from a shell instead live in /usr/ lib or /usr/libexec. /usr/include (C/C++ Headers) The /usr/include directory contains C and C++ header ﬁles, usually contained in packages with the -devel suﬃx. /usr/lib and /usr/lib64 (Shared libraries) On Amazon Linux 2023, the /usr/lib64 path is used for 64-bit shared libraries, and package data which is architecture dependent. Since AL2023 does not ship with any 32-bit userspace support, there are only 64-bit shared libraries available. The /usr/lib path is for static data from OS packages which is compatible with all architectures. This may include executables not usually invoked from a shell, which may also be found in /usr/ libexec. Shared libraries are found in /usr/lib64 rather than /usr/lib. /usr/local (System administrator installed software) On Amazon Linux 2023, the /usr/local path is available for the system administrator to install software in, software that is not owned by the OS, and will not be touched by the OS. The default /usr/local hierarchy mirrors the / hierarchy. /usr/share (Shared resources) Shared resources such as documentation, fonts, and time zone data live in /usr/share. It is common for various speciﬁcations to dictate exactly where and in what format data is stored in this directory. /usr/share/doc (Documentation) Documentation that comes with packages will be stored in /usr/share/doc. /var (Persistent Variable System Data) /usr/bin 431 Amazon Linux 2023 /var/cache (Cache) User Guide In contrast to /var/lib, erasing data in /var/cache will not result in data loss, as applications are required to be able to rebuild their /var/cache data from other sources. /var/lib (Persistent system data) The /var/lib directory is used for persistent system data. Various system components will place data here which is private to that component. In contrast to /var/cache, erasing data in /var/ lib will result in data loss. For example, the PostgreSQL database server will by default store database data in /var/lib/ pgsql. The layout and ﬁle formats of this data is private to PostgreSQL, and it is persistent data as if erased, the user experiences data loss. /var/log (Persistent logs) This directory is used for storing persistent logs. It is recommended that software use the syslog(3) or sd_journal_print(3) API calls rather than directly storing log ﬁles under /var/ log. Note In AL2023 the systemd journal replaces rsyslog, which is a notable diﬀerence from the default Amazon Linux 2 conﬁguration. For more information on reading logs using journalctl, see the journalctl manual page. Many applications use their own mechanisms for writing, and sometimes rotating, log ﬁles found in /var/log. See the documentation for these applications on how to conﬁgure their log ﬁles. /var/spool (Mail and Printer queues) This directory is used for persistent data such as mail or printer queues. /var/tmp (larger temporary ﬁles) For small, size-bound temporary ﬁles, /tmp should possibly be used instead. /var/cache 432 Amazon Linux 2023 User Guide While /tmp is by default conﬁgured to be a tmpfs volume, /var/tmp is by default conﬁgured to be a path on the root ﬁle system, and is thus the place for larger and more persistent temporary ﬁles. By default, there is a cleanup job run on a regular schedule which removes ﬁles not recently accessed. For information on how to conﬁgure the clean-up of temporary ﬁles, see the tmpfiles.d(5) and systemd-tmpfiles(8) man man pages. As with /tmp, applications should prefer the path speciﬁed in the $TMPDIR environment variable over /var/tmp. Users can then set the $TMPDIR environment variable to override the path an application should use for /var/tmp. Warning Since /var/tmp is shared (as is /tmp, it is important to use safe methods of creating temporary ﬁles. For details, see the upstream systemd documentation on Using /tmp and /var/tmp Safely. Note It is best practice for systemd services to be conﬁgured with the PrivateTmp= directive set to yes or disconnected which runs the service in a sandbox where /tmp and /var/ tmp are not shared with the host or other services. For more information, including how to conﬁgure two services to share the same private temporary directories, see the systemd.exec(5) man page. The /tmp and /var/tmp paths are closely related and exist for diﬀerent purposes. /var/tmp 433 Amazon Linux 2023 User Guide Updating AL2023 It's important to keep up to date with AL2023 releases so that you can beneﬁt from security updates and new features. With AL2023,
al2023-ug-089	al2023-ug.pdf	89	services to be conﬁgured with the PrivateTmp= directive set to yes or disconnected which runs the service in a sandbox where /tmp and /var/ tmp are not shared with the host or other services. For more information, including how to conﬁgure two services to share the same private temporary directories, see the systemd.exec(5) man page. The /tmp and /var/tmp paths are closely related and exist for diﬀerent purposes. /var/tmp 433 Amazon Linux 2023 User Guide Updating AL2023 It's important to keep up to date with AL2023 releases so that you can beneﬁt from security updates and new features. With AL2023, you can ensure consistency between package versions and updates across your environment through Deterministic upgrades through versioned repositories on AL2023. Warning Running dnf --releasever=latest update is not best practice, and is likely to result in an OS update being ﬁrst tested in production. Instead of using latest, use a speciﬁc AL2023 release version. This ensures you are deploying the same changes across production instances as you previously tested. For example, dnf --releasever=2023.7.20250331 update will always update to the 2023.7.20250331 release. For more information, see the Updating AL2023 section in the AL2023 User Guide. Topics • Best practices for safely deploying updates • Receive notiﬁcations on new updates • Deterministic upgrades through versioned repositories on AL2023 • Manage package and operating system updates in AL2023 • Kernel Live Patching on AL2023 • Updating the Linux kernel on AL2023 Best practices for safely deploying updates Amazon Linux 2023 (AL2023) has several features designed to aid in safely deploying updates to the Operating System, and being able to know what changed between updates, and if necessary, easily revert to the older version. This section explores lessons learned by AWS from more than a decade of internal and external use of Amazon Linux. Best practices for safely deploying updates 434 Amazon Linux 2023 Warning User Guide Running dnf --releasever=latest update is not best practice, and is likely to result in an OS update being ﬁrst tested in production. Instead of using latest, use a speciﬁc AL2023 release version. This ensures you are deploying the same changes across production instances as you previously tested. For example, dnf --releasever=2023.7.20250331 update will always update to the 2023.7.20250331 release. For more information, see the Updating AL2023 section in the AL2023 User Guide. Without planning for deployment safety of OS updates, the impact of an unexpected negative interaction between your application/service and an OS update can be signiﬁcantly greater, up to and including a total outage. As with any software issue, the earlier the issue is detected, the less impact it can have on end users. It is important to not fall into the trap of believing two things which are fundamentally not true: 1. The OS vendor will never make a mistake in an update to the OS. 2. The speciﬁc behavior of or interface to the OS that you rely on matches behavior and interfaces that the OS vendor would consider something to be relied upon. i.e. both the OS vendor and you would agree that there was a problem with the update. Do not rely on good intentions, put systems in place to ensure that deployment safety includes any update to the OS. It is not recommended to test new OS updates by deploying to production environments. It is best practice to consider the OS as another part of your deployment, and think about applying the same deployment safety mechanisms you consider suitable for any other change to a production environment. It is best practice to test any and all OS updates before deploying to production systems. When deploying, staged rollouts combined with good monitoring are recommended. Staged rollouts can ensure that if a problem occurs, even if not immediate, impact is restricted to a subset of a ﬂeet, and further deployment of the update can be halted while further investigation and mitigation can occur. Best practices for safely deploying updates 435 Amazon Linux 2023 User Guide The mitigation of any negative impact of taking an update to the OS is often the ﬁrst priority, followed by resolving the issue, wherever it may be. Where the introduction of an OS update is correlated to negative impact, the ability to revert to the previous known-good version of the OS is a powerful tool to have. Amazon Linux 2023 introduces Deterministic upgrades through versioned repositories, a powerful new feature to ensure any change to the version of the OS (or individual packages) is repeatable. Thus, if a problem is encounted when moving from one OS version to the next, there are simple to use mechanisms available to stick to the known-working OS version while working out how to resolve the problem. With AL2023, whenever we release new package updates, there's a new version to lock to, and new
al2023-ug-090	al2023-ug.pdf	90	the ability to revert to the previous known-good version of the OS is a powerful tool to have. Amazon Linux 2023 introduces Deterministic upgrades through versioned repositories, a powerful new feature to ensure any change to the version of the OS (or individual packages) is repeatable. Thus, if a problem is encounted when moving from one OS version to the next, there are simple to use mechanisms available to stick to the known-working OS version while working out how to resolve the problem. With AL2023, whenever we release new package updates, there's a new version to lock to, and new AMIs that lock to that version. The AL2023 Release Notes cover changes in each release, and Amazon Linux Security advisories for AL2023 covers security issues addressed in package updates. For example, if you were aﬀected by the issue present in the 2023.6.20241028 release, you could immediately revert to using the AMIs and container images of the prior release, 2023.6.20241010. In this case, there was a bug in a package that was ﬁxed in the subsequent 2023.6.20241031 release, but with Deterministic upgrades through versioned repositories anyone aﬀected could immediately take simple action to mitigate: just use the previous images. Deterministic upgrades through versioned repositories also gives assurance that any in-progress deployment of an OS update, either in place or by launching new AMIs or container images, are not aﬀected by subsequently released OS updates. For our ﬁrst example, ﬂeet A is a large ﬂeet which is halfway through deploying the update from 2023.5.20241001 to the 2023.6.20241010 release when the 2023.6.20241028 release comes out. Deterministic upgrades through versioned repositories means that the deployment for ﬂeet A continues without any change to what updates it is applying. The purpose of wave based or phase based deployment strategies such as ﬁrst deploying to 1% of a ﬂeet, then 5%, 10%, 20%, 40%, until reaching 100%, is to be able to test a change in a limited fashion before rolling it out wider. This type of deployment strategy is commonly considered best practice for deploying any production change. With a wave based deployment strategy and the ﬂeet A update to 2023.6.20241010 being at a stage where it's being deployed to a lot of hosts at once, the fact that 2023.6.20241028 was released has no impact on the in-progress deployment thanks to using Deterministic upgrades through versioned repositories. Best practices for safely deploying updates 436 Amazon Linux 2023 User Guide If ﬂeet B was running an older version, say 2023.5.20240708, and had started deploying the update to 2023.6.20241028, and ﬂeet B was aﬀected by the issue in that version, this would be noticed early in the deployment. At that point, a decision can be made on if to pause any rollout until a ﬁx for that issue is available, or if in the meantime to start a deployment of the same version ﬂeet A was running, 2023.6.20241010 so that ﬂeet B gets all the updates between 2023.5.20240708 and 2023.6.20241010. It is important to note that not taking OS updates promptly can cause issues. New updates likely contain bug and security ﬁxes which may be relevant to your environment. For more information, see Security and Compliance in Amazon Linux 2023 and Manage package and operating system updates in AL2023. It is important to conﬁgure your deployment systems to be able to easily take new OS updates, test them before deploying to production, and use mechanisms such as wave based deployments to minimize any negative impact. In order to be able to mitigate any negative impact of an OS update, it is important to know how to make your deployment systems point to a previous known- good version of the OS, and once the issue is addressed, no longer be locked to the older known- good version but rather move to a new known-good version. Preparing for Minor Updates Preparing for smaller updates to the OS, such as a new point release of AL2023 is intended to be limited to zero eﬀort. Be sure to read the AL2023 Release Notes for any upcoming changes. The support period of a package coming to an end may involve moving to a newer version of the language runtime (such as with PHP in AL2023). It is best practice to prepare for this in advance by moving to new language run time versions comfortably in advance of the support period ending. For packages such as pcre version 1, there is also the opportunity to plan in advance and migrate any of your code to its replacement, which in this case is pcre version 2. It is best practice to do so as soon as possible, to allow time for any setbacks. Where there is no direct replacement, such as with Berkeley DB (libdb), you may need to make a choice based on
al2023-ug-091	al2023-ug.pdf	91	PHP in AL2023). It is best practice to prepare for this in advance by moving to new language run time versions comfortably in advance of the support period ending. For packages such as pcre version 1, there is also the opportunity to plan in advance and migrate any of your code to its replacement, which in this case is pcre version 2. It is best practice to do so as soon as possible, to allow time for any setbacks. Where there is no direct replacement, such as with Berkeley DB (libdb), you may need to make a choice based on your use case. Preparing for Major Updates Updating to a new major version of an Operating System is near universally viewed as something which requires planning, work to adapt to changed or deprecated functionality, and also testing prior to deployment. It is not uncommon to be able to prepare for the next major version of Preparing for Minor Updates 437 Amazon Linux 2023 User Guide Amazon Linux 2023 more incrementally, such as addressing any use of deprecated or removed functionality before proceeding with moving to the next major version. For example, when moving from AL2 to AL2023, reading the Functionality deprecated in AL2 and removed in AL2023 section can result in a number of safe and small steps which can happen while still using AL2 to prepare for AL2023. For example, any Python 2.7 has been replaced with Python 3 usage (outside of OS use such as in the yum package manager) can be migrated to Python 3 in preparation for using Python in AL2023. If using PHP, both AL2 (through the PHP 8.2 AL2 Extra) and AL2023 ship PHP 8.2, and thus both PHP version migration and OS migration do not have to occur simultaneously. While using AL2023, it is also possible to prepare for the next major version of Amazon Linux 2023 today, while using AL2023. The Deprecated in AL2023 section covers features and packages which are deprecated in AL2023 and due to be removed. For example, migrating any remaining System V init (sysvinit) use, such as init scripts over to their systemd equivalent will prepare you for the future, as well as allow you to use the full set of systemd features to monitor the service, how and if to restart it, what other services it needs, and if any resource or permission constraints should be applied. For features such as 32-bit support, deprecation can span multiple major versions of the OS. For 32-bit, Amazon Linux 1 (AL1) deprecated 32-bit x86 (i686) AMIs, Amazon Linux 2 deprecated 32- bit x86 (i686) Packages, and Amazon Linux 2023 deprecates 32bit x86 (i686) runtime support. The transition away from IMDSv1 also spans multiple major versions of the OS. For these types of changes, it is understood that some customers require a longer time to adapt to them, thus there is a large amount of leeway before the functionality is no longer available in Amazon Linux 2023. The list of deprecated functionality is updated over the lifetime of the OS, and it is advisable to keep up to date with changes to it. Receive notiﬁcations on new updates You can receive notiﬁcations whenever a new AL2023 AMI is released. Notiﬁcations are published with Amazon SNS using the following topic. arn:aws:sns:us-east-1:137112412989:amazon-linux-2023-ami-updates Messages are posted here when a new AL2023 AMI is published. The version of the AMI will be included in the message. Receive notiﬁcations on new updates 438 Amazon Linux 2023 User Guide These messages can be received using several diﬀerent methods. We recommend that you use the following method. 1. Open the Amazon SNS console. 2. In the navigation bar, change the AWS Region to US East (N. Virginia), if necessary. You must select the Region where the SNS notiﬁcation that you're subscribing to was created. 3. In the navigation pane, choose Subscriptions, Create subscription. 4. For the Create subscription dialog box, do the following: a. For Topic ARN, copy and paste the following Amazon Resource Name (ARN): arn:aws:sns:us-east-1:137112412989:amazon-linux-2023-ami-updates. b. For Protocol, choose Email. c. For Endpoint, enter an email address that you can use to receive the notiﬁcations. d. Choose Create subscription. 5. You receive a conﬁrmation email with the subject line "AWS Notiﬁcation - Subscription Conﬁrmation". Open the email and choose Conﬁrm subscription to complete your subscription. Deterministic upgrades through versioned repositories on AL2023 Note By default, your AL2023 instance doesn't automatically receive additional critical and important security updates at launch. Your instance initially contains the updates that were available in the version of AL2023 and the chosen AMI. Control the updates received from major and minor releases With AL2023, you can ensure consistency between package versions and updates across your environment. You can also ensure consistency for multiple instances of the same Amazon Machine Image (AMI). With
al2023-ug-092	al2023-ug.pdf	92	the subject line "AWS Notiﬁcation - Subscription Conﬁrmation". Open the email and choose Conﬁrm subscription to complete your subscription. Deterministic upgrades through versioned repositories on AL2023 Note By default, your AL2023 instance doesn't automatically receive additional critical and important security updates at launch. Your instance initially contains the updates that were available in the version of AL2023 and the chosen AMI. Control the updates received from major and minor releases With AL2023, you can ensure consistency between package versions and updates across your environment. You can also ensure consistency for multiple instances of the same Amazon Machine Image (AMI). With the deterministic upgrades through versioned repositories feature, which is turned on by default, you can apply updates based on a schedule that meets your speciﬁc needs. Whenever we release new package updates, there's a new version to lock to, and new AMIs that lock to that version. Deterministic upgrades through versioned repositories 439 Amazon Linux 2023 User Guide AL2023 locks to a speciﬁc version of your repository. This is supported for both major or minor versions. The AL2023 AMI, exposed through our SSM parameters, is always the latest version. It has the most up-to-date packages and updates, including critical and important security updates. If you launch an instance from an existing AMI, updates aren't automatically applied. Any additional packages that are installed as part of your provisioning map to the repository version of the existing AMI. With this feature, you're in charge of ensuring consistency among package versions and updates across your environment. This is particularly the case if you're launching multiple instances from the same AMI. You can apply updates based on a schedule that meets your needs. You can also apply a speciﬁc set of updates on launch because these can also be locked to a speciﬁc repository version. Diﬀerences between minor and major version upgrades Major version releases of AL2023 include large-scale updates and might add, delete, or update packages. To ensure compatibility, upgrade your instance to a new major version only after you test your application on that version. Minor version releases of AL2023 include feature and security updates, but don't include package changes. This ensures that Linux features and the system library API stay available on new versions. Testing your application before updating isn't necessary. Knowing when updates are available In order to apply an update, you need to know that one is available, and then know how to deploy the update. For building derived AMIs when new AL2023 AMIs are released, EC2 Image Builder can automatically build, patch, and test AMIs. To trigger your own AMI building pipelines, or to use the base AMIs, you can Receive notiﬁcations on new updates. For patching in-place, you can use tools such as AWS Systems Manager Patch Manager to orchestrate applying updates across a ﬂeet. For other public AMIs based on AL2023, the providers of those AMIs may have their own release schedule and notiﬁcation methods. When using derived AMIs or container images, check the documentation from the publisher as to when updates are released. Diﬀerences between minor and major version upgrades 440 Amazon Linux 2023 User Guide The changes in each release are documented in the AL2023 release notes. Security updates are published on Amazon Linux Security Center (ALAS). Control the package updates available from the AL2023 repositories When we publish a new version of the AL2023 repositories, all previous versions are still available. By default, the plugin for managing repository versions locks to the same version that was used to build the AMI. If you want to control package updates, follow these steps. 1. Discover available repository versions by running the following command. $ sudo dnf check-release-update 2. Select a version by running the following command. $ sudo dnf upgrade --releasever=version This command starts an update using dnf from your current Amazon Linux release version to the release version that's speciﬁed in the command line. A list of the package updates is presented by dnf. Before the update is processed, you must conﬁrm the update. After the update is complete, the new release version becomes the default release version that dnf uses for all future activities. For more information, see Manage package and operating system updates in AL2023. Deterministic updates via instance replacement The Deterministic upgrades through versioned repositories on AL2023 feature of Amazon Linux 2023 makes instance replacement an easy way to deterministically and safely roll out updated versions of AL2023. Deterministic updates mean that as a new version is progressively rolled out, if any issue is found, it's simple to revert to the previous AMI while determining the cause of the issue. Using instance replacement rather than patching in-place means that updates are more deterministic and predictable as launching new capacity can be a well tested code-path with clear A and B states.
al2023-ug-093	al2023-ug.pdf	93	updates in AL2023. Deterministic updates via instance replacement The Deterministic upgrades through versioned repositories on AL2023 feature of Amazon Linux 2023 makes instance replacement an easy way to deterministically and safely roll out updated versions of AL2023. Deterministic updates mean that as a new version is progressively rolled out, if any issue is found, it's simple to revert to the previous AMI while determining the cause of the issue. Using instance replacement rather than patching in-place means that updates are more deterministic and predictable as launching new capacity can be a well tested code-path with clear A and B states. Each of the before and after states can be well tested in a CI/CD system before deployment starts. When doing in-place patching, there are a lot of intermediary states between before and after applying updates, which is harder to test for all combinations of states. Control the package updates available from the AL2023 repositories 441 Amazon Linux 2023 User Guide An OS update strategy of using instance replacement with deterministic updates ﬁts well into blue/green, wave, and phase based deployment models. Using Deterministic upgrades through versioned repositories Topics • Using a deterministic upgraded system • Selective update of a deterministic upgraded system • Using persistent override with deterministic upgrade Using a deterministic upgraded system Note The default behavior of the package manager has changed from AL2. Deterministic upgrades are a powerful way to ensure all changes to production environments can be fully tested before wide deployment. Each new AL2023 AMI is locked to a particular version of AL2023. This provides deterministic behavior of what versions of OS packages are installed when launching the speciﬁc AMI. In-place updates can be to a speciﬁc release version, ensuring deterministic behavior across a ﬂeet. As you move to new AMIs or in-place update versions, you can test each one in your CI/CD pipeline, catching any potential issues before deploying to production environments. You can use tools such as AWS Systems Manager Patch Manager to orchestrate applying updates across a ﬂeet. For building derived AMIs when new AL2023 AMIs are released, EC2 Image Builder can automatically build, patch, and test AMIs, or you can Receive notiﬁcations on new updates to know when new base AMIs are available, or to trigger your own AMI building pipelines. For information on restricting updates to those from a particular advisory, see Applying security updates in-place For patching in-place, you can use the dnf package manager. When you run the dnf upgrade command, the system checks for upgrades in the repository that the releasever variable speciﬁes. A valid releasever is either latest or a date-stamped version such as 2023.7.20250331. In-place Deterministic upgrades 442 Amazon Linux 2023 User Guide You can change the value of releasever using one of the following methods. These methods are listed in descending system priority. This means that method 1 overrides methods 2 and 3, and method 2 overrides method 3. 1. The value in the command line ﬂag, --releasever=latest, if it's used. 2. The value that's speciﬁed in the override variable ﬁle, /etc/dnf/vars/releasever, if it's set. 3. The currently installed version of the system-release package. In the following example, the version is 2023.0.20230210: $ rpm -q system-release system-release-2023.0.20230210-0.amzn2023.noarch In a newly installed system, the override variable is not present. No upgrades are available because the system is locked to the installed version of system-release. $ cat /etc/dnf/vars/releasever cat: /etc/dnf/vars/releasever: No such file or directory $ sudo dnf upgrade Last metadata expiration check: 0:00:02 ago on Wed 15 Feb 2023 06:14:12 PM UTC. Dependencies resolved. Nothing to do. Complete! You can get packages of a speciﬁc version by using the releasever ﬂag to provide the version that you want. $ rpm -q system-release system-release-2023.0.20230222-0.amzn2023.noarch $ sudo dnf upgrade --releasever=2023.0.20230329 Amazon Linux 2023 repository 26 MB/s \| 12 MB 00:00 Dependencies resolved. ================================================================================ Package Arch Version Repository Size ================================================================================ Installing: In-place Deterministic upgrades 443 Amazon Linux 2023 User Guide kernel aarch64 6.1.21-1.45.amzn2023 amazonlinux 26 M Upgrading: amazon-linux-repo-s3 noarch 2023.0.20230329-0.amzn2023 amazonlinux 18 k ca-certificates noarch 2023.2.60-1.0.amzn2023.0.1 amazonlinux 828 k cloud-init noarch 22.2.2-1.amzn2023.1.7 amazonlinux 1.1 M ... [ list edited for clarity ] system-release noarch 2023.0.20230329-0.amzn2023 amazonlinux 29 k ... [ list edited for clarity ] vim-data noarch 2:9.0.1403-1.amzn2023.0.1 amazonlinux 25 k vim-minimal aarch64 2:9.0.1403-1.amzn2023.0.1 amazonlinux 753 k Transaction Summary ================================================================================ Install 1 Package Upgrade 42 Packages Total download size: 56 M Because the --releasever option overrides both system-release and /etc/dnf/vars/ releasever, the result of this upgrade is the following: 1. The upgrade replaces all installed packages that changed between the previous and new versions. 2. The upgrade locks the system to the repository for the new version of system-release. By always specifying what releasever (i.e. AL2023 release) to update to, you have a deterministic set of changes across a ﬂeet. You launched version A, updated to B, and
al2023-ug-094	al2023-ug.pdf	94	amazonlinux 25 k vim-minimal aarch64 2:9.0.1403-1.amzn2023.0.1 amazonlinux 753 k Transaction Summary ================================================================================ Install 1 Package Upgrade 42 Packages Total download size: 56 M Because the --releasever option overrides both system-release and /etc/dnf/vars/ releasever, the result of this upgrade is the following: 1. The upgrade replaces all installed packages that changed between the previous and new versions. 2. The upgrade locks the system to the repository for the new version of system-release. By always specifying what releasever (i.e. AL2023 release) to update to, you have a deterministic set of changes across a ﬂeet. You launched version A, updated to B, and then updated to C. Selective update of a deterministic upgraded system Note We recommend that all updates in a new release are installed rather than selecting speciﬁc updates. Only applying part of an update to the OS should be an exception to standard practice of taking the whole update. In-place Deterministic upgrades 444 Amazon Linux 2023 User Guide You might want to install selected packages from a recent release, while leaving the system locked to the original release version. You can use dnf check-update to identify the packages that you want to upgrade. $ sudo dnf check-update --releasever=latest --security Amazon Linux 2023 repository 13 MB/s \| 10 MB 00:00 Last metadata expiration check: 0:00:02 ago on Wed 15 Feb 2023 02:52:21 AM UTC. bind-libs.aarch64 32:9.16.27-1.amzn2023.0.1 amazonlinux bind-license.noarch 32:9.16.27-1.amzn2023.0.1 amazonlinux bind-utils.aarch64 32:9.16.27-1.amzn2023.0.1 amazonlinux cryptsetup.aarch64 2.4.3-2.amzn2023.0.1 amazonlinux cryptsetup-libs.aarch64 2.4.3-2.amzn2023.0.1 amazonlinux curl-minimal.aarch64 7.85.0-1.amzn2023.0.1 amazonlinux glibc.aarch64 2.34-40.amzn2023.0.2 amazonlinux glibc-all-langpacks.aarch64 2.34-40.amzn2023.0.2 amazonlinux glibc-common.aarch64 2.34-40.amzn2023.0.2 amazonlinux glibc-locale-source.aarch64 2.34-40.amzn2023.0.2 amazonlinux gmp.aarch64 1:6.2.1-2.amzn2023.0.1 amazonlinux gnupg2-minimal.aarch64 2.3.7-1.amzn2023.0.2 amazonlinux gzip.aarch64 1.10-5.amzn2023.0.1 amazonlinux kernel.aarch64 6.1.12-17.42.amzn2023 amazonlinux kernel-tools.aarch64 6.1.12-17.42.amzn2023 amazonlinux libarchive.aarch64 3.5.3-2.amzn2023.0.1 amazonlinux libcurl-minimal.aarch64 7.85.0-1.amzn2023.0.1 amazonlinux libsepol.aarch64 3.4-3.amzn2023.0.2 amazonlinux libsolv.aarch64 0.7.22-1.amzn2023.0.1 amazonlinux libxml2.aarch64 2.9.14-1.amzn2023.0.1 amazonlinux logrotate.aarch64 3.20.1-2.amzn2023.0.2 amazonlinux lua-libs.aarch64 5.4.4-3.amzn2023.0.1 amazonlinux lz4-libs.aarch64 1.9.4-1.amzn2023.0.1 amazonlinux openssl.aarch64 1:3.0.5-1.amzn2023.0.3 amazonlinux openssl-libs.aarch64 1:3.0.5-1.amzn2023.0.3 amazonlinux pcre2.aarch64 10.40-1.amzn2023.0.1 amazonlinux pcre2-syntax.noarch 10.40-1.amzn2023.0.1 amazonlinux rsync.aarch64 3.2.6-1.amzn2023.0.2 amazonlinux vim-common.aarch64 2:9.0.475-1.amzn2023.0.1 amazonlinux vim-data.noarch 2:9.0.475-1.amzn2023.0.1 amazonlinux vim-enhanced.aarch64 2:9.0.475-1.amzn2023.0.1 amazonlinux vim-filesystem.noarch 2:9.0.475-1.amzn2023.0.1 amazonlinux vim-minimal.aarch64 2:9.0.475-1.amzn2023.0.1 amazonlinux xz.aarch64 5.2.5-9.amzn2023.0.1 amazonlinux xz-libs.aarch64 5.2.5-9.amzn2023.0.1 amazonlinux In-place Deterministic upgrades 445 Amazon Linux 2023 User Guide zlib.aarch64 1.2.11-32.amzn2023.0.3 amazonlinux Install the packages that you want to upgrade. Use sudo dnf upgrade --releasever=latest and the package names to ensure that the system-release package remains unchanged. $ sudo dnf upgrade --releasever=latest openssl openssl-libs Last metadata expiration check: 0:01:28 ago on Wed 15 Feb 2023 02:52:21 AM UTC. Dependencies resolved. ================================================================================ Package Arch Version Repository Size ================================================================================ Upgrading: openssl aarch64 1:3.0.5-1.amzn2023.0.3 amazonlinux 1.1 M openssl-libs aarch64 1:3.0.5-1.amzn2023.0.3 amazonlinux 2.1 M Transaction Summary ================================================================================ Upgrade 2 Packages Total download size: 3.2 M Note Using sudo dnf upgrade --releasever=latest updates all packages, including system-release. Then, the version remains locked to the new system-release unless you set the persistent override. Using persistent override with deterministic upgrade Note With deterministic updates, you can integrate OS changes into your CI/CD pipeline. Disabling deterministic updates removes the ability to test before deploying. Instead of adding --releasever=latest, you can use persistent override to unlock the system by setting the variable value to latest. By always using latest, this reverts the behavior of AL2023 to the AL2 update model, where any call to the package manager will always look at the latest release, and is not locked to any speciﬁc version of the OS. In-place Deterministic upgrades 446 Amazon Linux 2023 Warning User Guide By unlocking the package manager by using a persistent override of deterministic updates, you take the risk discovering any possible incompatibility between your application and an OS update in production. While incompatibilites are rare, with an OS update you are integrating new code changes into your environment, integration tests can prevent deploying code changes that have a negative impact on production environments. $ echo latest \| sudo tee /etc/dnf/vars/releasever latest $ sudo dnf upgrade Last metadata expiration check: 0:03:36 ago on Wed 15 Feb 2023 02:52:21 AM UTC. Dependencies resolved. ================================================================================ Package Arch Version Repository Size ================================================================================ Installing: kernel aarch64 6.1.73-45.135.amzn2023 amazonlinux 24 M Upgrading: acl aarch64 2.3.1-2.amzn2023.0.1 amazonlinux 72 k alternatives aarch64 1.15-2.amzn2023.0.1 amazonlinux 36 k amazon-ec2-net-utils noarch 2.3.0-1.amzn2023.0.1 amazonlinux 16 k at aarch64 3.1.23-6.amzn2023.0.1 amazonlinux 60 k attr aarch64 2.5.1-3.amzn2023.0.1 amazonlinux 59 k audit aarch64 3.0.6-1.amzn2023.0.1 amazonlinux 249 k audit-libs aarch64 3.0.6-1.amzn2023.0.1 amazonlinux 116 k aws-c-auth-libs aarch64 0.6.5-6.amzn2023.0.2 amazonlinux 79 k aws-c-cal-libs aarch64 0.5.12-7.amzn2023.0.2 amazonlinux 34 k aws-c-common-libs aarch64 0.6.14-6.amzn2023.0.2 amazonlinux 119 k aws-c-compression-libs aarch64 0.2.14-5.amzn2023.0.2 amazonlinux 22 k aws-c-event-stream-libs aarch64 0.2.7-5.amzn2023.0.2 amazonlinux 47 k aws-c-http-libs aarch64 0.6.8-6.amzn2023.0.2 amazonlinux 147 k aws-c-io-libs aarch64 0.10.12-5.amzn2023.0.6 amazonlinux 109 k aws-c-mqtt-libs aarch64 0.7.8-7.amzn2023.0.2 amazonlinux 61 k aws-c-s3-libs aarch64 0.1.27-5.amzn2023.0.3 amazonlinux 54 k aws-c-sdkutils-libs aarch64 0.1.1-5.amzn2023.0.2 amazonlinux 26 k aws-checksums-libs aarch64 0.1.12-5.amzn2023.0.2 amazonlinux 50 k awscli-2 noarch 2.7.8-1.amzn2023.0.4 amazonlinux 7.3 M In-place Deterministic upgrades 447 Amazon Linux 2023 User Guide basesystem noarch 11-11.amzn2023.0.1 amazonlinux 7.8 k bash aarch64 5.1.8-2.amzn2023.0.1 amazonlinux 1.6 M bash-completion noarch 1:2.11-2.amzn2023.0.1 amazonlinux 292 k bc aarch64 1.07.1-14.amzn2023.0.1 amazonlinux 120 k bind-libs aarch64 32:9.16.27-1.amzn2023.0.1 amazonlinux
al2023-ug-095	al2023-ug.pdf	95	amazonlinux 34 k aws-c-common-libs aarch64 0.6.14-6.amzn2023.0.2 amazonlinux 119 k aws-c-compression-libs aarch64 0.2.14-5.amzn2023.0.2 amazonlinux 22 k aws-c-event-stream-libs aarch64 0.2.7-5.amzn2023.0.2 amazonlinux 47 k aws-c-http-libs aarch64 0.6.8-6.amzn2023.0.2 amazonlinux 147 k aws-c-io-libs aarch64 0.10.12-5.amzn2023.0.6 amazonlinux 109 k aws-c-mqtt-libs aarch64 0.7.8-7.amzn2023.0.2 amazonlinux 61 k aws-c-s3-libs aarch64 0.1.27-5.amzn2023.0.3 amazonlinux 54 k aws-c-sdkutils-libs aarch64 0.1.1-5.amzn2023.0.2 amazonlinux 26 k aws-checksums-libs aarch64 0.1.12-5.amzn2023.0.2 amazonlinux 50 k awscli-2 noarch 2.7.8-1.amzn2023.0.4 amazonlinux 7.3 M In-place Deterministic upgrades 447 Amazon Linux 2023 User Guide basesystem noarch 11-11.amzn2023.0.1 amazonlinux 7.8 k bash aarch64 5.1.8-2.amzn2023.0.1 amazonlinux 1.6 M bash-completion noarch 1:2.11-2.amzn2023.0.1 amazonlinux 292 k bc aarch64 1.07.1-14.amzn2023.0.1 amazonlinux 120 k bind-libs aarch64 32:9.16.27-1.amzn2023.0.1 amazonlinux 1.2 M bind-license noarch 32:9.16.27-1.amzn2023.0.1 amazonlinux 14 k bind-utils aarch64 32:9.16.27-1.amzn2023.0.1 amazonlinux 206 k binutils aarch64 2.38-20.amzn2023.0.3 amazonlinux 4.6 M boost-filesystem aarch64 1.75.0-4.amzn2023.0.1 amazonlinux 55 k boost-system aarch64 1.75.0-4.amzn2023.0.1 amazonlinux 14 k boost-thread aarch64 1.75.0-4.amzn2023.0.1 amazonlinux 54 k bzip2 aarch64 1.0.8-6.amzn2023.0.1 amazonlinux 53 k bzip2-libs aarch64 1.0.8-6.amzn2023.0.1 amazonlinux 44 k c-ares aarch64 1.17.2-1.amzn2023.0.1 amazonlinux 107 k ca-certificates noarch 2021.2.50-1.0.amzn2023.0.3 amazonlinux 343 k checkpolicy aarch64 3.4-3.amzn2023.0.1 amazonlinux 345 k chkconfig aarch64 1.15-2.amzn2023.0.1 amazonlinux 162 k chrony aarch64 4.2-7.amzn2023.0.4 amazonlinux 314 k cloud-init noarch 22.2.2-1.amzn2023.1.7 amazonlinux 1.1 M cloud-utils-growpart aarch64 0.31-8.amzn2023.0.2 amazonlinux 31 k coreutils aarch64 8.32-30.amzn2023.0.2 amazonlinux 1.1 M coreutils-common aarch64 8.32-30.amzn2023.0.2 amazonlinux 2.0 M cpio aarch64 2.13-10.amzn2023.0.1 amazonlinux 269 k cracklib aarch64 2.9.6-27.amzn2023.0.1 amazonlinux 83 k cracklib-dicts aarch64 2.9.6-27.amzn2023.0.1 amazonlinux 3.6 M crontabs noarch 1.11-24.20190603git.amzn2023.0.1 amazonlinux 19 k crypto-policies noarch 20230128-1.gitdfb10ea.amzn2023.0.1 amazonlinux 61 k crypto-policies-scripts noarch 20230128-1.gitdfb10ea.amzn2023.0.1 amazonlinux 81 k ... Installing dependencies: amazon-linux-repo-cdn noarch 2023.0.20230210-0.amzn2023 amazonlinux 16 k xxhash-libs aarch64 0.8.0-3.amzn2023.0.1 amazonlinux 32 k Installing weak dependencies: amazon-chrony-config noarch 4.2-7.amzn2023.0.4 amazonlinux 14 k gawk-all-langpacks aarch64 5.1.0-3.amzn2023.0.1 amazonlinux 207 k Transaction Summary ================================================================================ Install 5 Packages Upgrade 413 Packages In-place Deterministic upgrades 448 Amazon Linux 2023 Total download size: 199 M Note User Guide If you used the override variable /etc/dnf/vars/releasever, use the following command to restore the default locking behavior by erasing the override value. $ sudo rm /etc/dnf/vars/releasever The use of a persistent override to using latest rather than a specﬁic version is akin to the default behavior of AL2. There are services that build AMIs based on AL2 which disable this behavior, and lock to speciﬁc package versions like you get by default on AL2023. Rather than disabling deterministic updates, we recommend replacing instances with ones launched from a new AMI. If instance replacement is not an option, we recommend using tools such as AWS Systems Manager Patch Manager to orchestrate applying updates across a ﬂeet. EC2 Image Builder can also automatically build, patch, and test your own AMIs derived from AL2023 base images. You can also Receive notiﬁcations on new updates which can be used to trigger your own AMI building pipelines. Using latest in a pre-production environment, and then deploying to production using latest does not provide protection from any issue between an OS update and your application. A new AL2023 release can be at any point in time, and thus all uses of latest in production carry risk. Manage package and operating system updates in AL2023 Unlike previous versions of Amazon Linux, AL2023 AMIs are locked to a speciﬁc version of the Amazon Linux repository. To apply both security and bug ﬁxes to an AL2023 instance, update the DNF conﬁguration to the latest available release version. Alternatively, launch a newer AL2023 instance. This section describes how to manage DNF packages and repositories on a running instance. It also describes how to conﬁgure DNF from a user data script to enable the latest available Amazon Linux repository at launch time. For more information, see DNF Command Reference. It is recommended to apply all updates available in a new AL2023 release. Picking just security updates, or only speciﬁc updates should be the exception rather than rule. For listing which Managing updates 449 Amazon Linux 2023 User Guide Security advisories are relevant to a particular instance, see Listing applicable Advisories. For information on installing only updates relevant to a speciﬁc Advisory, see Applying security updates in-place. Important If you want to report a vulnerability or have a security concern regarding AWS cloud services or open source projects, contact AWS Security using the Vulnerability Reporting page Topics • Checking for available package updates • Applying security updates using DNF and repository versions • Automatic service restart after (security) updates • When is a reboot required to apply security updates? • Launching an instance with the latest repository version enabled • Getting package support information • Checking for newer repository versions with dnf check-release-update • Adding, enabling, or disabling new repositories • Adding repositories with cloud-init Checking for available package updates You can use the dnf check-update command to check for any updates for your system. For AL2023, we recommend that you add the --releasever=version-number option to the command. When you add this option, DNF also checks for updates
al2023-ug-096	al2023-ug.pdf	96	DNF and repository versions • Automatic service restart after (security) updates • When is a reboot required to apply security updates? • Launching an instance with the latest repository version enabled • Getting package support information • Checking for newer repository versions with dnf check-release-update • Adding, enabling, or disabling new repositories • Adding repositories with cloud-init Checking for available package updates You can use the dnf check-update command to check for any updates for your system. For AL2023, we recommend that you add the --releasever=version-number option to the command. When you add this option, DNF also checks for updates for a later version of the repository. For example, after you run the dnf check-update command, use the latest returned version as the value for the version-number. If the instance is updated to use the latest version of the repository, the output includes a list of all the packages to be updated. Checking for available package updates 450 Amazon Linux 2023 Note User Guide If you don't specify the release version with the optional ﬂag to the dnf check-update command, only the currently conﬁgured repository version is checked. This means that packages in the later version of the repository aren't checked. Updates in a speciﬁc version In this example we are going to look at what updates are available in the 2023.1.20230628 release if we launched a container of the 2023.0.20230315 release. Note This example uses the 2023.0.20230315 and 2023.1.20230628 releases, and these are not the latest release of AL2023 See the AL2023 Release Notes for the latest releases, which contain the latest security updates. In this example we will be starting with a container image for the 2023.0.20230315 release. First, we fetch this container image from the container registry. The .0 at the end indicates the version of the image for a particular release; this image version is usually zero. $ docker pull public.ecr.aws/amazonlinux/amazonlinux:2023.0.20230315.0 2023.0.20230315.0: Pulling from amazonlinux/amazonlinux b76f3b09316a: Pull complete Digest: sha256:94e7183b0739140dbd5b639fb7600f0a2299cec5df8780c26d9cb409da5315a9 Status: Downloaded newer image for public.ecr.aws/amazonlinux/ amazonlinux:2023.0.20230315.0 public.ecr.aws/amazonlinux/amazonlinux:2023.0.20230315.0 We can now spawn a shell inside the container, from which we will check for updates. $ docker run -it public.ecr.aws/amazonlinux/amazonlinux:2023.0.20230315.0 bash-5.2# The dnf check-update command is now used to check updates available in the 2023.1.20230628 release. Checking for available package updates 451 Amazon Linux 2023 Note User Guide Applying package updates is a privileged operation. Although elevating privileges is typically not required when running in a container, if running in a non-containerized environment such as an Amazon EC2 instance, you can check for updates without elevating privileges. $ dnf check-update --releasever=2023.1.20230628 Amazon Linux 2023 repository 60 MB/s \| 15 MB 00:00 Last metadata expiration check: 0:00:02 ago on Mon Jul 22 17:25:34 2024. amazon-linux-repo-cdn.noarch 2023.1.20230628-0.amzn2023 amazonlinux ca-certificates.noarch 2023.2.60-1.0.amzn2023.0.2 amazonlinux curl-minimal.x86_64 8.0.1-1.amzn2023 amazonlinux glib2.x86_64 2.74.7-688.amzn2023.0.1 amazonlinux glibc.x86_64 2.34-52.amzn2023.0.3 amazonlinux glibc-common.x86_64 2.34-52.amzn2023.0.3 amazonlinux glibc-minimal-langpack.x86_64 2.34-52.amzn2023.0.3 amazonlinux gnupg2-minimal.x86_64 2.3.7-1.amzn2023.0.4 amazonlinux keyutils-libs.x86_64 1.6.3-1.amzn2023 amazonlinux libcap.x86_64 2.48-2.amzn2023.0.3 amazonlinux libcurl-minimal.x86_64 8.0.1-1.amzn2023 amazonlinux libgcc.x86_64 11.3.1-4.amzn2023.0.3 amazonlinux libgomp.x86_64 11.3.1-4.amzn2023.0.3 amazonlinux libstdc++.x86_64 11.3.1-4.amzn2023.0.3 amazonlinux libxml2.x86_64 2.10.4-1.amzn2023.0.1 amazonlinux ncurses-base.noarch 6.2-4.20200222.amzn2023.0.4 amazonlinux ncurses-libs.x86_64 6.2-4.20200222.amzn2023.0.4 amazonlinux openssl-libs.x86_64 1:3.0.8-1.amzn2023.0.3 amazonlinux python3-rpm.x86_64 4.16.1.3-12.amzn2023.0.6 amazonlinux rpm.x86_64 4.16.1.3-12.amzn2023.0.6 amazonlinux rpm-build-libs.x86_64 4.16.1.3-12.amzn2023.0.6 amazonlinux rpm-libs.x86_64 4.16.1.3-12.amzn2023.0.6 amazonlinux rpm-sign-libs.x86_64 4.16.1.3-12.amzn2023.0.6 amazonlinux system-release.noarch 2023.1.20230628-0.amzn2023 amazonlinux tzdata.noarch 2023c-1.amzn2023.0.1 amazonlinux bash-5.2# Checking for available package updates 452 Amazon Linux 2023 User Guide The version of the system-release package shows the release that a dnf upgrade command would update to, which is the 2023.1.20230628 release that was requested in the dnf check-update --releasever=2023.1.20230628 command. Updates in the latest version In this example we are going to look at what updates are available in the latest version of AL2023 if we launched a container of the 2023.4.20240319 release. At the time of writing, the latest release is 2023.5.20240708, so the listed updates in this example will be as of that release. Note This example uses the 2023.4.20240319 and 2023.5.20240708 releases, the latter being the latest release at the time of writing. For more information on the latest releases, see the AL2023 Release Notes. In this example we will be starting with a container image for the 2023.4.20240319 release. First, we fetch this container image from the container registry. The .1 at the end indicates the version of the image for a particular release. While the image version is typically zero, this example uses a release where the image version is one. $ docker pull public.ecr.aws/amazonlinux/amazonlinux:2023.4.20240319.1 2023.4.20240319.1: Pulling from amazonlinux/amazonlinux 6de065fda9a2: Pull complete Digest: sha256:b4838c4cc9211d966b6ea158dacc9eda7433a16ba94436508c2d9f01f7658b4e Status: Downloaded newer image for public.ecr.aws/amazonlinux/ amazonlinux:2023.4.20240319.1 public.ecr.aws/amazonlinux/amazonlinux:2023.4.20240319.1 We can now spawn a shell inside the container, from which we will check for updates. $ docker run -it public.ecr.aws/amazonlinux/amazonlinux:2023.4.20240319.1 bash-5.2# The dnf check-update command is now used to check updates available in the latest release, which at the time of writing was 2023.5.20240708. Checking for available package updates 453 Amazon Linux 2023 Note User Guide Applying package updates is a privileged operation. Although elevating privileges is typically
al2023-ug-097	al2023-ug.pdf	97	example uses a release where the image version is one. $ docker pull public.ecr.aws/amazonlinux/amazonlinux:2023.4.20240319.1 2023.4.20240319.1: Pulling from amazonlinux/amazonlinux 6de065fda9a2: Pull complete Digest: sha256:b4838c4cc9211d966b6ea158dacc9eda7433a16ba94436508c2d9f01f7658b4e Status: Downloaded newer image for public.ecr.aws/amazonlinux/ amazonlinux:2023.4.20240319.1 public.ecr.aws/amazonlinux/amazonlinux:2023.4.20240319.1 We can now spawn a shell inside the container, from which we will check for updates. $ docker run -it public.ecr.aws/amazonlinux/amazonlinux:2023.4.20240319.1 bash-5.2# The dnf check-update command is now used to check updates available in the latest release, which at the time of writing was 2023.5.20240708. Checking for available package updates 453 Amazon Linux 2023 Note User Guide Applying package updates is a privileged operation. Although elevating privileges is typically not required when running in a container, if running in a non-containerized environment such as an Amazon EC2 instance, you can check for updates without elevating privileges. $ dnf --releasever=latest check-update Amazon Linux 2023 repository 78 MB/s \| 25 MB 00:00 Last metadata expiration check: 0:00:04 ago on Mon Jul 22 17:39:13 2024. amazon-linux-repo-cdn.noarch 2023.5.20240708-1.amzn2023 amazonlinux curl-minimal.x86_64 8.5.0-1.amzn2023.0.4 amazonlinux dnf.noarch 4.14.0-1.amzn2023.0.5 amazonlinux dnf-data.noarch 4.14.0-1.amzn2023.0.5 amazonlinux expat.x86_64 2.5.0-1.amzn2023.0.4 amazonlinux glibc.x86_64 2.34-52.amzn2023.0.10 amazonlinux glibc-common.x86_64 2.34-52.amzn2023.0.10 amazonlinux glibc-minimal-langpack.x86_64 2.34-52.amzn2023.0.10 amazonlinux krb5-libs.x86_64 1.21-3.amzn2023.0.4 amazonlinux libblkid.x86_64 2.37.4-1.amzn2023.0.4 amazonlinux libcurl-minimal.x86_64 8.5.0-1.amzn2023.0.4 amazonlinux libmount.x86_64 2.37.4-1.amzn2023.0.4 amazonlinux libnghttp2.x86_64 1.59.0-3.amzn2023.0.1 amazonlinux libsmartcols.x86_64 2.37.4-1.amzn2023.0.4 amazonlinux libuuid.x86_64 2.37.4-1.amzn2023.0.4 amazonlinux openssl-libs.x86_64 1:3.0.8-1.amzn2023.0.12 amazonlinux python3.x86_64 3.9.16-1.amzn2023.0.8 amazonlinux python3-dnf.noarch 4.14.0-1.amzn2023.0.5 amazonlinux python3-libs.x86_64 3.9.16-1.amzn2023.0.8 amazonlinux system-release.noarch 2023.5.20240708-1.amzn2023 amazonlinux yum.noarch 4.14.0-1.amzn2023.0.5 amazonlinux bash-5.2# The version of the system-release package shows the release that a dnf upgrade command would update to. Checking for available package updates 454 Amazon Linux 2023 User Guide For this command, if there are newer packages available, the return code is 100. If there aren't any newer packages available, the return code is 0. In addition, the output also lists all the packages to update. Applying security updates using DNF and repository versions New package updates and security updates are made available to new repository versions only. For instances that you launched from earlier AL2023 AMI versions, you must update the repository version before you can install security updates. The dnf check-release-update command includes an example update command that updates all the packages that are installed on the system to versions in a newer repository. Note If you don't specify the release version with the optional ﬂag to the dnf check-update command, only the currently conﬁgured repository version is checked. This means that any update to installed packages present in any later version of the repository aren't applied. This section covers the recommended upgrade path of applying all available updates rather than picking and choosing individual updates or only ones marked as security updates. By applying all updates, existing instances are moved to the same package set as launching an updated AMI. This consistency reduces the variation of package versions across a ﬂeet. For more information on applying speciﬁc updates, see Applying security updates in-place. Applying updates in a speciﬁc version In this example we are going to apply updates available in the 2023.1.20230628 release if we launched a container of the 2023.0.20230315 release. Note This example uses the 2023.0.20230315 and 2023.1.20230628 releases, and these are not the latest release of AL2023 See the AL2023 Release Notes for the latest releases, which contain the latest security updates. In this example we will be starting with a container image for the 2023.0.20230315 release. Applying security updates using DNF and repository versions 455 Amazon Linux 2023 User Guide First, we fetch this container image from the container registry. The .0 at the end indicates the version of the image for a particular release; this image version is usually zero. $ docker pull public.ecr.aws/amazonlinux/amazonlinux:2023.0.20230315.0 2023.0.20230315.0: Pulling from amazonlinux/amazonlinux b76f3b09316a: Pull complete Digest: sha256:94e7183b0739140dbd5b639fb7600f0a2299cec5df8780c26d9cb409da5315a9 Status: Downloaded newer image for public.ecr.aws/amazonlinux/ amazonlinux:2023.0.20230315.0 public.ecr.aws/amazonlinux/amazonlinux:2023.0.20230315.0 We can now spawn a shell inside the container, from which we will apply updates. $ docker run -it public.ecr.aws/amazonlinux/amazonlinux:2023.0.20230315.0 bash-5.2# The dnf upgrade command is now used to apply all of the updates present in the 2023.1.20230628 release. Note Applying package updates is a privileged operation. Although elevating privileges is typically not required when running in a container, if running in a non-containerized environment such as an Amazon EC2 instance, you will need to run the dnf upgrade command as the root user. This can be done using the sudo or su commands. $ dnf upgrade --releasever=2023.1.20230628 Amazon Linux 2023 repository 38 MB/s \| 15 MB 00:00 Last metadata expiration check: 0:00:02 ago on Mon Jul 22 17:49:08 2024. Dependencies resolved. ================================================================================= Package Arch Version Repository Size ================================================================================= Upgrading: amazon-linux-repo-cdn noarch 2023.1.20230628-0.amzn2023 amazonlinux 18 k ca-certificates noarch 2023.2.60-1.0.amzn2023.0.2 amazonlinux 829 k curl-minimal x86_64 8.0.1-1.amzn2023 amazonlinux 150 k glib2 x86_64 2.74.7-688.amzn2023.0.1 amazonlinux 2.7 M glibc x86_64 2.34-52.amzn2023.0.3 amazonlinux 1.9 M glibc-common x86_64 2.34-52.amzn2023.0.3 amazonlinux 307 k Applying security updates using DNF and repository versions 456 Amazon Linux 2023 User Guide glibc-minimal-langpack x86_64 2.34-52.amzn2023.0.3 amazonlinux 35 k gnupg2-minimal x86_64 2.3.7-1.amzn2023.0.4 amazonlinux 421 k keyutils-libs x86_64 1.6.3-1.amzn2023
al2023-ug-098	al2023-ug.pdf	98	dnf upgrade --releasever=2023.1.20230628 Amazon Linux 2023 repository 38 MB/s \| 15 MB 00:00 Last metadata expiration check: 0:00:02 ago on Mon Jul 22 17:49:08 2024. Dependencies resolved. ================================================================================= Package Arch Version Repository Size ================================================================================= Upgrading: amazon-linux-repo-cdn noarch 2023.1.20230628-0.amzn2023 amazonlinux 18 k ca-certificates noarch 2023.2.60-1.0.amzn2023.0.2 amazonlinux 829 k curl-minimal x86_64 8.0.1-1.amzn2023 amazonlinux 150 k glib2 x86_64 2.74.7-688.amzn2023.0.1 amazonlinux 2.7 M glibc x86_64 2.34-52.amzn2023.0.3 amazonlinux 1.9 M glibc-common x86_64 2.34-52.amzn2023.0.3 amazonlinux 307 k Applying security updates using DNF and repository versions 456 Amazon Linux 2023 User Guide glibc-minimal-langpack x86_64 2.34-52.amzn2023.0.3 amazonlinux 35 k gnupg2-minimal x86_64 2.3.7-1.amzn2023.0.4 amazonlinux 421 k keyutils-libs x86_64 1.6.3-1.amzn2023 amazonlinux 33 k libcap x86_64 2.48-2.amzn2023.0.3 amazonlinux 67 k libcurl-minimal x86_64 8.0.1-1.amzn2023 amazonlinux 249 k libgcc x86_64 11.3.1-4.amzn2023.0.3 amazonlinux 105 k libgomp x86_64 11.3.1-4.amzn2023.0.3 amazonlinux 280 k libstdc++ x86_64 11.3.1-4.amzn2023.0.3 amazonlinux 744 k libxml2 x86_64 2.10.4-1.amzn2023.0.1 amazonlinux 706 k ncurses-base noarch 6.2-4.20200222.amzn2023.0.4 amazonlinux 60 k ncurses-libs x86_64 6.2-4.20200222.amzn2023.0.4 amazonlinux 328 k openssl-libs x86_64 1:3.0.8-1.amzn2023.0.3 amazonlinux 2.2 M python3-rpm x86_64 4.16.1.3-12.amzn2023.0.6 amazonlinux 88 k rpm x86_64 4.16.1.3-12.amzn2023.0.6 amazonlinux 486 k rpm-build-libs x86_64 4.16.1.3-12.amzn2023.0.6 amazonlinux 90 k rpm-libs x86_64 4.16.1.3-12.amzn2023.0.6 amazonlinux 309 k rpm-sign-libs x86_64 4.16.1.3-12.amzn2023.0.6 amazonlinux 21 k system-release noarch 2023.1.20230628-0.amzn2023 amazonlinux 29 k tzdata noarch 2023c-1.amzn2023.0.1 amazonlinux 433 k Transaction Summary ================================================================================= Upgrade 25 Packages Total download size: 12 M Is this ok [y/N]: The version of the system-release package shows the release that a dnf upgrade command would update to, which is the 2023.1.20230628 release that was requested in the dnf upgrade --releasever=2023.1.20230628 command. By default, dnf will ask you to conﬁrm you wish to apply the updates. You can bypass this prompt by using the -y ﬂag to dnf. for this example, the dnf upgrade -y -- releasever=2023.1.20230628 command would not ask for conﬁrmation before applying the updates. This is useful in scripts or other automation environments. Once conﬁrming you want to apply the updates, dnf applies them. Is this ok [y/N]:y Downloading Packages: (1/25): libcap-2.48-2.amzn2023.0.3.x86_64.rpm 1.5 MB/s \| 67 kB 00:00 (2/25): python3-rpm-4.16.1.3-12.amzn2023.0.6.x86 2.1 MB/s \| 88 kB 00:00 (3/25): libcurl-minimal-8.0.1-1.amzn2023.x86_64. 2.6 MB/s \| 249 kB 00:00 Applying security updates using DNF and repository versions 457 Amazon Linux 2023 User Guide (4/25): glib2-2.74.7-688.amzn2023.0.1.x86_64.rpm 26 MB/s \| 2.7 MB 00:00 (5/25): glibc-minimal-langpack-2.34-52.amzn2023. 1.3 MB/s \| 35 kB 00:00 (6/25): rpm-build-libs-4.16.1.3-12.amzn2023.0.6. 2.8 MB/s \| 90 kB 00:00 (7/25): rpm-libs-4.16.1.3-12.amzn2023.0.6.x86_64 6.6 MB/s \| 309 kB 00:00 (8/25): libgcc-11.3.1-4.amzn2023.0.3.x86_64.rpm 3.9 MB/s \| 105 kB 00:00 (9/25): glibc-common-2.34-52.amzn2023.0.3.x86_64 11 MB/s \| 307 kB 00:00 (10/25): glibc-2.34-52.amzn2023.0.3.x86_64.rpm 31 MB/s \| 1.9 MB 00:00 (11/25): rpm-sign-libs-4.16.1.3-12.amzn2023.0.6. 877 kB/s \| 21 kB 00:00 (12/25): gnupg2-minimal-2.3.7-1.amzn2023.0.4.x86 15 MB/s \| 421 kB 00:00 (13/25): openssl-libs-3.0.8-1.amzn2023.0.3.x86_6 35 MB/s \| 2.2 MB 00:00 (14/25): libxml2-2.10.4-1.amzn2023.0.1.x86_64.rp 14 MB/s \| 706 kB 00:00 (15/25): curl-minimal-8.0.1-1.amzn2023.x86_64.rp 4.2 MB/s \| 150 kB 00:00 (16/25): rpm-4.16.1.3-12.amzn2023.0.6.x86_64.rpm 11 MB/s \| 486 kB 00:00 (17/25): libgomp-11.3.1-4.amzn2023.0.3.x86_64.rp 7.0 MB/s \| 280 kB 00:00 (18/25): libstdc++-11.3.1-4.amzn2023.0.3.x86_64. 14 MB/s \| 744 kB 00:00 (19/25): keyutils-libs-1.6.3-1.amzn2023.x86_64.r 1.6 MB/s \| 33 kB 00:00 (20/25): ncurses-libs-6.2-4.20200222.amzn2023.0. 10 MB/s \| 328 kB 00:00 (21/25): tzdata-2023c-1.amzn2023.0.1.noarch.rpm 11 MB/s \| 433 kB 00:00 (22/25): amazon-linux-repo-cdn-2023.1.20230628-0 781 kB/s \| 18 kB 00:00 (23/25): ca-certificates-2023.2.60-1.0.amzn2023. 16 MB/s \| 829 kB 00:00 (24/25): system-release-2023.1.20230628-0.amzn20 1.5 MB/s \| 29 kB 00:00 (25/25): ncurses-base-6.2-4.20200222.amzn2023.0. 3.1 MB/s \| 60 kB 00:00 --------------------------------------------------------------------------------- Total 28 MB/s \| 12 MB 00:00 Running transaction check Transaction check succeeded. Running transaction test Transaction test succeeded. Running transaction Preparing : 1/1 Upgrading : libgcc-11.3.1-4.amzn2023.0.3.x86_64 1/50 Running scriptlet: libgcc-11.3.1-4.amzn2023.0.3.x86_64 1/50 Upgrading : system-release-2023.1.20230628-0.amzn2023.noarch 2/50 Upgrading : amazon-linux-repo-cdn-2023.1.20230628-0.amzn2023.no 3/50 Upgrading : ncurses-base-6.2-4.20200222.amzn2023.0.4.noarch 4/50 Upgrading : tzdata-2023c-1.amzn2023.0.1.noarch 5/50 Upgrading : glibc-common-2.34-52.amzn2023.0.3.x86_64 6/50 Running scriptlet: glibc-2.34-52.amzn2023.0.3.x86_64 7/50 Upgrading : glibc-2.34-52.amzn2023.0.3.x86_64 7/50 Running scriptlet: glibc-2.34-52.amzn2023.0.3.x86_64 7/50 Upgrading : glibc-minimal-langpack-2.34-52.amzn2023.0.3.x86_64 8/50 Upgrading : libcap-2.48-2.amzn2023.0.3.x86_64 9/50 Upgrading : gnupg2-minimal-2.3.7-1.amzn2023.0.4.x86_64 10/50 Upgrading : libgomp-11.3.1-4.amzn2023.0.3.x86_64 11/50 Applying security updates using DNF and repository versions 458 Amazon Linux 2023 User Guide Running scriptlet: ca-certificates-2023.2.60-1.0.amzn2023.0.2.noarch 12/50 Upgrading : ca-certificates-2023.2.60-1.0.amzn2023.0.2.noarch 12/50 Running scriptlet: ca-certificates-2023.2.60-1.0.amzn2023.0.2.noarch 12/50 Upgrading : openssl-libs-1:3.0.8-1.amzn2023.0.3.x86_64 13/50 Upgrading : libcurl-minimal-8.0.1-1.amzn2023.x86_64 14/50 Upgrading : curl-minimal-8.0.1-1.amzn2023.x86_64 15/50 Upgrading : rpm-libs-4.16.1.3-12.amzn2023.0.6.x86_64 16/50 Upgrading : rpm-4.16.1.3-12.amzn2023.0.6.x86_64 17/50 Upgrading : rpm-build-libs-4.16.1.3-12.amzn2023.0.6.x86_64 18/50 Upgrading : rpm-sign-libs-4.16.1.3-12.amzn2023.0.6.x86_64 19/50 Upgrading : python3-rpm-4.16.1.3-12.amzn2023.0.6.x86_64 20/50 Upgrading : glib2-2.74.7-688.amzn2023.0.1.x86_64 21/50 Upgrading : libxml2-2.10.4-1.amzn2023.0.1.x86_64 22/50 Upgrading : libstdc++-11.3.1-4.amzn2023.0.3.x86_64 23/50 Upgrading : keyutils-libs-1.6.3-1.amzn2023.x86_64 24/50 Upgrading : ncurses-libs-6.2-4.20200222.amzn2023.0.4.x86_64 25/50 Cleanup : glib2-2.73.2-680.amzn2023.0.3.x86_64 26/50 Cleanup : libstdc++-11.3.1-4.amzn2023.0.2.x86_64 27/50 Cleanup : libxml2-2.10.3-2.amzn2023.0.1.x86_64 28/50 Cleanup : python3-rpm-4.16.1.3-12.amzn2023.0.5.x86_64 29/50 Cleanup : rpm-build-libs-4.16.1.3-12.amzn2023.0.5.x86_64 30/50 Cleanup : rpm-sign-libs-4.16.1.3-12.amzn2023.0.5.x86_64 31/50 Cleanup : rpm-libs-4.16.1.3-12.amzn2023.0.5.x86_64 32/50 Cleanup : libcap-2.48-2.amzn2023.0.2.x86_64 33/50 Cleanup : gnupg2-minimal-2.3.7-1.amzn2023.0.3.x86_64 34/50 Cleanup : ncurses-libs-6.2-4.20200222.amzn2023.0.3.x86_64 35/50 Cleanup : libgomp-11.3.1-4.amzn2023.0.2.x86_64 36/50 Cleanup : rpm-4.16.1.3-12.amzn2023.0.5.x86_64 37/50 Cleanup : curl-minimal-7.88.1-1.amzn2023.0.1.x86_64 38/50 Cleanup : libcurl-minimal-7.88.1-1.amzn2023.0.1.x86_64 39/50 Cleanup : openssl-libs-1:3.0.8-1.amzn2023.0.1.x86_64 40/50 Cleanup : keyutils-libs-1.6.1-2.amzn2023.0.2.x86_64 41/50 Cleanup : amazon-linux-repo-cdn-2023.0.20230315-1.amzn2023.no 42/50 Cleanup : system-release-2023.0.20230315-1.amzn2023.noarch 43/50 Cleanup : ca-certificates-2023.2.60-1.0.amzn2023.0.1.noarch 44/50 Cleanup : ncurses-base-6.2-4.20200222.amzn2023.0.3.noarch 45/50 Cleanup : glibc-minimal-langpack-2.34-52.amzn2023.0.2.x86_64 46/50 Cleanup : glibc-2.34-52.amzn2023.0.2.x86_64 47/50 Cleanup : glibc-common-2.34-52.amzn2023.0.2.x86_64 48/50 Cleanup : tzdata-2022g-1.amzn2023.0.1.noarch 49/50 Cleanup : libgcc-11.3.1-4.amzn2023.0.2.x86_64 50/50 Running scriptlet: libgcc-11.3.1-4.amzn2023.0.2.x86_64 50/50 Running scriptlet: ca-certificates-2023.2.60-1.0.amzn2023.0.2.noarch 50/50 Running scriptlet: rpm-4.16.1.3-12.amzn2023.0.6.x86_64
al2023-ug-099	al2023-ug.pdf	99	28/50 Cleanup : python3-rpm-4.16.1.3-12.amzn2023.0.5.x86_64 29/50 Cleanup : rpm-build-libs-4.16.1.3-12.amzn2023.0.5.x86_64 30/50 Cleanup : rpm-sign-libs-4.16.1.3-12.amzn2023.0.5.x86_64 31/50 Cleanup : rpm-libs-4.16.1.3-12.amzn2023.0.5.x86_64 32/50 Cleanup : libcap-2.48-2.amzn2023.0.2.x86_64 33/50 Cleanup : gnupg2-minimal-2.3.7-1.amzn2023.0.3.x86_64 34/50 Cleanup : ncurses-libs-6.2-4.20200222.amzn2023.0.3.x86_64 35/50 Cleanup : libgomp-11.3.1-4.amzn2023.0.2.x86_64 36/50 Cleanup : rpm-4.16.1.3-12.amzn2023.0.5.x86_64 37/50 Cleanup : curl-minimal-7.88.1-1.amzn2023.0.1.x86_64 38/50 Cleanup : libcurl-minimal-7.88.1-1.amzn2023.0.1.x86_64 39/50 Cleanup : openssl-libs-1:3.0.8-1.amzn2023.0.1.x86_64 40/50 Cleanup : keyutils-libs-1.6.1-2.amzn2023.0.2.x86_64 41/50 Cleanup : amazon-linux-repo-cdn-2023.0.20230315-1.amzn2023.no 42/50 Cleanup : system-release-2023.0.20230315-1.amzn2023.noarch 43/50 Cleanup : ca-certificates-2023.2.60-1.0.amzn2023.0.1.noarch 44/50 Cleanup : ncurses-base-6.2-4.20200222.amzn2023.0.3.noarch 45/50 Cleanup : glibc-minimal-langpack-2.34-52.amzn2023.0.2.x86_64 46/50 Cleanup : glibc-2.34-52.amzn2023.0.2.x86_64 47/50 Cleanup : glibc-common-2.34-52.amzn2023.0.2.x86_64 48/50 Cleanup : tzdata-2022g-1.amzn2023.0.1.noarch 49/50 Cleanup : libgcc-11.3.1-4.amzn2023.0.2.x86_64 50/50 Running scriptlet: libgcc-11.3.1-4.amzn2023.0.2.x86_64 50/50 Running scriptlet: ca-certificates-2023.2.60-1.0.amzn2023.0.2.noarch 50/50 Running scriptlet: rpm-4.16.1.3-12.amzn2023.0.6.x86_64 50/50 Applying security updates using DNF and repository versions 459 Amazon Linux 2023 User Guide Running scriptlet: libgcc-11.3.1-4.amzn2023.0.2.x86_64 50/50 Verifying : libcurl-minimal-8.0.1-1.amzn2023.x86_64 1/50 Verifying : libcurl-minimal-7.88.1-1.amzn2023.0.1.x86_64 2/50 Verifying : libcap-2.48-2.amzn2023.0.3.x86_64 3/50 Verifying : libcap-2.48-2.amzn2023.0.2.x86_64 4/50 Verifying : glib2-2.74.7-688.amzn2023.0.1.x86_64 5/50 Verifying : glib2-2.73.2-680.amzn2023.0.3.x86_64 6/50 Verifying : python3-rpm-4.16.1.3-12.amzn2023.0.6.x86_64 7/50 Verifying : python3-rpm-4.16.1.3-12.amzn2023.0.5.x86_64 8/50 Verifying : glibc-minimal-langpack-2.34-52.amzn2023.0.3.x86_64 9/50 Verifying : glibc-minimal-langpack-2.34-52.amzn2023.0.2.x86_64 10/50 Verifying : rpm-libs-4.16.1.3-12.amzn2023.0.6.x86_64 11/50 Verifying : rpm-libs-4.16.1.3-12.amzn2023.0.5.x86_64 12/50 Verifying : rpm-build-libs-4.16.1.3-12.amzn2023.0.6.x86_64 13/50 Verifying : rpm-build-libs-4.16.1.3-12.amzn2023.0.5.x86_64 14/50 Verifying : glibc-2.34-52.amzn2023.0.3.x86_64 15/50 Verifying : glibc-2.34-52.amzn2023.0.2.x86_64 16/50 Verifying : libgcc-11.3.1-4.amzn2023.0.3.x86_64 17/50 Verifying : libgcc-11.3.1-4.amzn2023.0.2.x86_64 18/50 Verifying : glibc-common-2.34-52.amzn2023.0.3.x86_64 19/50 Verifying : glibc-common-2.34-52.amzn2023.0.2.x86_64 20/50 Verifying : rpm-sign-libs-4.16.1.3-12.amzn2023.0.6.x86_64 21/50 Verifying : rpm-sign-libs-4.16.1.3-12.amzn2023.0.5.x86_64 22/50 Verifying : openssl-libs-1:3.0.8-1.amzn2023.0.3.x86_64 23/50 Verifying : openssl-libs-1:3.0.8-1.amzn2023.0.1.x86_64 24/50 Verifying : gnupg2-minimal-2.3.7-1.amzn2023.0.4.x86_64 25/50 Verifying : gnupg2-minimal-2.3.7-1.amzn2023.0.3.x86_64 26/50 Verifying : libxml2-2.10.4-1.amzn2023.0.1.x86_64 27/50 Verifying : libxml2-2.10.3-2.amzn2023.0.1.x86_64 28/50 Verifying : curl-minimal-8.0.1-1.amzn2023.x86_64 29/50 Verifying : curl-minimal-7.88.1-1.amzn2023.0.1.x86_64 30/50 Verifying : rpm-4.16.1.3-12.amzn2023.0.6.x86_64 31/50 Verifying : rpm-4.16.1.3-12.amzn2023.0.5.x86_64 32/50 Verifying : libstdc++-11.3.1-4.amzn2023.0.3.x86_64 33/50 Verifying : libstdc++-11.3.1-4.amzn2023.0.2.x86_64 34/50 Verifying : libgomp-11.3.1-4.amzn2023.0.3.x86_64 35/50 Verifying : libgomp-11.3.1-4.amzn2023.0.2.x86_64 36/50 Verifying : keyutils-libs-1.6.3-1.amzn2023.x86_64 37/50 Verifying : keyutils-libs-1.6.1-2.amzn2023.0.2.x86_64 38/50 Verifying : ncurses-libs-6.2-4.20200222.amzn2023.0.4.x86_64 39/50 Verifying : ncurses-libs-6.2-4.20200222.amzn2023.0.3.x86_64 40/50 Verifying : ca-certificates-2023.2.60-1.0.amzn2023.0.2.noarch 41/50 Verifying : ca-certificates-2023.2.60-1.0.amzn2023.0.1.noarch 42/50 Verifying : tzdata-2023c-1.amzn2023.0.1.noarch 43/50 Applying security updates using DNF and repository versions 460 Amazon Linux 2023 User Guide Verifying : tzdata-2022g-1.amzn2023.0.1.noarch 44/50 Verifying : amazon-linux-repo-cdn-2023.1.20230628-0.amzn2023.no 45/50 Verifying : amazon-linux-repo-cdn-2023.0.20230315-1.amzn2023.no 46/50 Verifying : system-release-2023.1.20230628-0.amzn2023.noarch 47/50 Verifying : system-release-2023.0.20230315-1.amzn2023.noarch 48/50 Verifying : ncurses-base-6.2-4.20200222.amzn2023.0.4.noarch 49/50 Verifying : ncurses-base-6.2-4.20200222.amzn2023.0.3.noarch 50/50 Upgraded: amazon-linux-repo-cdn-2023.1.20230628-0.amzn2023.noarch ca-certificates-2023.2.60-1.0.amzn2023.0.2.noarch curl-minimal-8.0.1-1.amzn2023.x86_64 glib2-2.74.7-688.amzn2023.0.1.x86_64 glibc-2.34-52.amzn2023.0.3.x86_64 glibc-common-2.34-52.amzn2023.0.3.x86_64 glibc-minimal-langpack-2.34-52.amzn2023.0.3.x86_64 gnupg2-minimal-2.3.7-1.amzn2023.0.4.x86_64 keyutils-libs-1.6.3-1.amzn2023.x86_64 libcap-2.48-2.amzn2023.0.3.x86_64 libcurl-minimal-8.0.1-1.amzn2023.x86_64 libgcc-11.3.1-4.amzn2023.0.3.x86_64 libgomp-11.3.1-4.amzn2023.0.3.x86_64 libstdc++-11.3.1-4.amzn2023.0.3.x86_64 libxml2-2.10.4-1.amzn2023.0.1.x86_64 ncurses-base-6.2-4.20200222.amzn2023.0.4.noarch ncurses-libs-6.2-4.20200222.amzn2023.0.4.x86_64 openssl-libs-1:3.0.8-1.amzn2023.0.3.x86_64 python3-rpm-4.16.1.3-12.amzn2023.0.6.x86_64 rpm-4.16.1.3-12.amzn2023.0.6.x86_64 rpm-build-libs-4.16.1.3-12.amzn2023.0.6.x86_64 rpm-libs-4.16.1.3-12.amzn2023.0.6.x86_64 rpm-sign-libs-4.16.1.3-12.amzn2023.0.6.x86_64 system-release-2023.1.20230628-0.amzn2023.noarch tzdata-2023c-1.amzn2023.0.1.noarch Complete! bash-5.2# Updates in the latest version In this example we are going to apply updates available in the latest version of AL2023 if we launched a container of the 2023.4.20240319 release. At the time of writing, the latest release is 2023.5.20240708, so the listed updates in this example will be as of that release. Applying security updates using DNF and repository versions 461 Amazon Linux 2023 Note User Guide This example uses the 2023.4.20240319 and 2023.5.20240708 releases, the latter being the latest release at the time of writing. For more information on the latest releases, see the AL2023 Release Notes. In this example we will be starting with a container image for the 2023.4.20240319 release. First, we fetch this container image from the container registry. The .1 at the end indicates the version of the image for a particular release. While the image version is typically zero, this example uses a release where the image version is one. $ docker pull public.ecr.aws/amazonlinux/amazonlinux:2023.4.20240319.1 2023.4.20240319.1: Pulling from amazonlinux/amazonlinux 6de065fda9a2: Pull complete Digest: sha256:b4838c4cc9211d966b6ea158dacc9eda7433a16ba94436508c2d9f01f7658b4e Status: Downloaded newer image for public.ecr.aws/amazonlinux/ amazonlinux:2023.4.20240319.1 public.ecr.aws/amazonlinux/amazonlinux:2023.4.20240319.1 We can now spawn a shell inside the container, from which we will apply updates. $ docker run -it public.ecr.aws/amazonlinux/amazonlinux:2023.4.20240319.1 bash-5.2# The dnf upgrade command is now used to apply updates available in the latest release, which at the time of writing was 2023.5.20240708. Note Applying package updates is a privileged operation. Although elevating privileges is typically not required when running in a container, if running in a non-containerized environment such as an Amazon EC2 instance, you will need to run the dnf upgrade command as the root user. This can be done using the sudo or su commands. By default, dnf will ask you to conﬁrm you wish to apply the updates. In this example, we are bypassing this prompt by using the -y ﬂag to dnf. Applying security updates using DNF and repository versions 462 Amazon Linux 2023 User Guide $ dnf -y --releasever=latest update Amazon Linux 2023 repository 75 MB/s \| 25 MB 00:00 Last metadata expiration check: 0:00:04 ago on Mon Jul 22 18:00:10 2024. Dependencies resolved. ================================================================================= Package Arch Version Repository Size ================================================================================= Upgrading: amazon-linux-repo-cdn noarch 2023.5.20240708-1.amzn2023 amazonlinux 17 k curl-minimal x86_64 8.5.0-1.amzn2023.0.4 amazonlinux 160 k dnf noarch 4.14.0-1.amzn2023.0.5 amazonlinux 460 k dnf-data noarch 4.14.0-1.amzn2023.0.5 amazonlinux 34 k expat x86_64 2.5.0-1.amzn2023.0.4 amazonlinux 117 k glibc x86_64 2.34-52.amzn2023.0.10 amazonlinux 1.9 M glibc-common x86_64 2.34-52.amzn2023.0.10 amazonlinux 295 k glibc-minimal-langpack x86_64 2.34-52.amzn2023.0.10 amazonlinux 23 k krb5-libs x86_64 1.21-3.amzn2023.0.4 amazonlinux 758 k libblkid x86_64 2.37.4-1.amzn2023.0.4 amazonlinux 105 k libcurl-minimal x86_64 8.5.0-1.amzn2023.0.4 amazonlinux 275 k libmount x86_64 2.37.4-1.amzn2023.0.4 amazonlinux 132 k libnghttp2 x86_64 1.59.0-3.amzn2023.0.1 amazonlinux 79 k libsmartcols x86_64 2.37.4-1.amzn2023.0.4 amazonlinux
al2023-ug-100	al2023-ug.pdf	100	0:00:04 ago on Mon Jul 22 18:00:10 2024. Dependencies resolved. ================================================================================= Package Arch Version Repository Size ================================================================================= Upgrading: amazon-linux-repo-cdn noarch 2023.5.20240708-1.amzn2023 amazonlinux 17 k curl-minimal x86_64 8.5.0-1.amzn2023.0.4 amazonlinux 160 k dnf noarch 4.14.0-1.amzn2023.0.5 amazonlinux 460 k dnf-data noarch 4.14.0-1.amzn2023.0.5 amazonlinux 34 k expat x86_64 2.5.0-1.amzn2023.0.4 amazonlinux 117 k glibc x86_64 2.34-52.amzn2023.0.10 amazonlinux 1.9 M glibc-common x86_64 2.34-52.amzn2023.0.10 amazonlinux 295 k glibc-minimal-langpack x86_64 2.34-52.amzn2023.0.10 amazonlinux 23 k krb5-libs x86_64 1.21-3.amzn2023.0.4 amazonlinux 758 k libblkid x86_64 2.37.4-1.amzn2023.0.4 amazonlinux 105 k libcurl-minimal x86_64 8.5.0-1.amzn2023.0.4 amazonlinux 275 k libmount x86_64 2.37.4-1.amzn2023.0.4 amazonlinux 132 k libnghttp2 x86_64 1.59.0-3.amzn2023.0.1 amazonlinux 79 k libsmartcols x86_64 2.37.4-1.amzn2023.0.4 amazonlinux 62 k libuuid x86_64 2.37.4-1.amzn2023.0.4 amazonlinux 26 k openssl-libs x86_64 1:3.0.8-1.amzn2023.0.12 amazonlinux 2.2 M python3 x86_64 3.9.16-1.amzn2023.0.8 amazonlinux 27 k python3-dnf noarch 4.14.0-1.amzn2023.0.5 amazonlinux 409 k python3-libs x86_64 3.9.16-1.amzn2023.0.8 amazonlinux 7.3 M system-release noarch 2023.5.20240708-1.amzn2023 amazonlinux 28 k yum noarch 4.14.0-1.amzn2023.0.5 amazonlinux 32 k Transaction Summary ================================================================================= Upgrade 21 Packages Total download size: 14 M Downloading Packages: (1/21): amazon-linux-repo-cdn-2023.5.20240708-1. 345 kB/s \| 17 kB 00:00 (2/21): dnf-4.14.0-1.amzn2023.0.5.noarch.rpm 6.8 MB/s \| 460 kB 00:00 (3/21): dnf-data-4.14.0-1.amzn2023.0.5.noarch.rp 1.6 MB/s \| 34 kB 00:00 (4/21): expat-2.5.0-1.amzn2023.0.4.x86_64.rpm 4.6 MB/s \| 117 kB 00:00 (5/21): glibc-2.34-52.amzn2023.0.10.x86_64.rpm 38 MB/s \| 1.9 MB 00:00 (6/21): glibc-common-2.34-52.amzn2023.0.10.x86_6 8.8 MB/s \| 295 kB 00:00 (7/21): glibc-minimal-langpack-2.34-52.amzn2023. 1.7 MB/s \| 23 kB 00:00 Applying security updates using DNF and repository versions 463 Amazon Linux 2023 User Guide (8/21): curl-minimal-8.5.0-1.amzn2023.0.4.x86_64 998 kB/s \| 160 kB 00:00 (9/21): libblkid-2.37.4-1.amzn2023.0.4.x86_64.rp 4.1 MB/s \| 105 kB 00:00 (10/21): krb5-libs-1.21-3.amzn2023.0.4.x86_64.rp 16 MB/s \| 758 kB 00:00 (11/21): libmount-2.37.4-1.amzn2023.0.4.x86_64.r 7.9 MB/s \| 132 kB 00:00 (12/21): libnghttp2-1.59.0-3.amzn2023.0.1.x86_64 5.6 MB/s \| 79 kB 00:00 (13/21): libsmartcols-2.37.4-1.amzn2023.0.4.x86_ 4.4 MB/s \| 62 kB 00:00 (14/21): libcurl-minimal-8.5.0-1.amzn2023.0.4.x8 7.1 MB/s \| 275 kB 00:00 (15/21): libuuid-2.37.4-1.amzn2023.0.4.x86_64.rp 1.1 MB/s \| 26 kB 00:00 (16/21): python3-3.9.16-1.amzn2023.0.8.x86_64.rp 1.5 MB/s \| 27 kB 00:00 (17/21): python3-dnf-4.14.0-1.amzn2023.0.5.noarc 19 MB/s \| 409 kB 00:00 (18/21): system-release-2023.5.20240708-1.amzn20 1.9 MB/s \| 28 kB 00:00 (19/21): yum-4.14.0-1.amzn2023.0.5.noarch.rpm 1.6 MB/s \| 32 kB 00:00 (20/21): openssl-libs-3.0.8-1.amzn2023.0.12.x86_ 26 MB/s \| 2.2 MB 00:00 (21/21): python3-libs-3.9.16-1.amzn2023.0.8.x86_ 59 MB/s \| 7.3 MB 00:00 --------------------------------------------------------------------------------- Total 34 MB/s \| 14 MB 00:00 Running transaction check Transaction check succeeded. Running transaction test Transaction test succeeded. Running transaction Preparing : 1/1 Upgrading : glibc-common-2.34-52.amzn2023.0.10.x86_64 1/42 Upgrading : glibc-minimal-langpack-2.34-52.amzn2023.0.10.x86_64 2/42 Running scriptlet: glibc-2.34-52.amzn2023.0.10.x86_64 3/42 Upgrading : glibc-2.34-52.amzn2023.0.10.x86_64 3/42 Running scriptlet: glibc-2.34-52.amzn2023.0.10.x86_64 3/42 Upgrading : libuuid-2.37.4-1.amzn2023.0.4.x86_64 4/42 Upgrading : openssl-libs-1:3.0.8-1.amzn2023.0.12.x86_64 5/42 Upgrading : krb5-libs-1.21-3.amzn2023.0.4.x86_64 6/42 Upgrading : libblkid-2.37.4-1.amzn2023.0.4.x86_64 7/42 Running scriptlet: libblkid-2.37.4-1.amzn2023.0.4.x86_64 7/42 Upgrading : expat-2.5.0-1.amzn2023.0.4.x86_64 8/42 Upgrading : python3-3.9.16-1.amzn2023.0.8.x86_64 9/42 Upgrading : python3-libs-3.9.16-1.amzn2023.0.8.x86_64 10/42 Upgrading : libnghttp2-1.59.0-3.amzn2023.0.1.x86_64 11/42 Upgrading : libcurl-minimal-8.5.0-1.amzn2023.0.4.x86_64 12/42 Upgrading : system-release-2023.5.20240708-1.amzn2023.noarch 13/42 Upgrading : amazon-linux-repo-cdn-2023.5.20240708-1.amzn2023.no 14/42 Upgrading : dnf-data-4.14.0-1.amzn2023.0.5.noarch 15/42 Upgrading : python3-dnf-4.14.0-1.amzn2023.0.5.noarch 16/42 Upgrading : dnf-4.14.0-1.amzn2023.0.5.noarch 17/42 Running scriptlet: dnf-4.14.0-1.amzn2023.0.5.noarch 17/42 Upgrading : yum-4.14.0-1.amzn2023.0.5.noarch 18/42 Applying security updates using DNF and repository versions 464 Amazon Linux 2023 User Guide Upgrading : curl-minimal-8.5.0-1.amzn2023.0.4.x86_64 19/42 Upgrading : libmount-2.37.4-1.amzn2023.0.4.x86_64 20/42 Upgrading : libsmartcols-2.37.4-1.amzn2023.0.4.x86_64 21/42 Cleanup : yum-4.14.0-1.amzn2023.0.4.noarch 22/42 Running scriptlet: dnf-4.14.0-1.amzn2023.0.4.noarch 23/42 Cleanup : dnf-4.14.0-1.amzn2023.0.4.noarch 23/42 Running scriptlet: dnf-4.14.0-1.amzn2023.0.4.noarch 23/42 Cleanup : python3-dnf-4.14.0-1.amzn2023.0.4.noarch 24/42 Cleanup : amazon-linux-repo-cdn-2023.4.20240319-1.amzn2023.no 25/42 Cleanup : libmount-2.37.4-1.amzn2023.0.3.x86_64 26/42 Cleanup : curl-minimal-8.5.0-1.amzn2023.0.2.x86_64 27/42 Cleanup : libcurl-minimal-8.5.0-1.amzn2023.0.2.x86_64 28/42 Cleanup : krb5-libs-1.21-3.amzn2023.0.3.x86_64 29/42 Cleanup : libblkid-2.37.4-1.amzn2023.0.3.x86_64 30/42 Cleanup : libnghttp2-1.57.0-1.amzn2023.0.1.x86_64 31/42 Cleanup : libsmartcols-2.37.4-1.amzn2023.0.3.x86_64 32/42 Cleanup : system-release-2023.4.20240319-1.amzn2023.noarch 33/42 Cleanup : dnf-data-4.14.0-1.amzn2023.0.4.noarch 34/42 Cleanup : python3-3.9.16-1.amzn2023.0.6.x86_64 35/42 Cleanup : python3-libs-3.9.16-1.amzn2023.0.6.x86_64 36/42 Cleanup : openssl-libs-1:3.0.8-1.amzn2023.0.11.x86_64 37/42 Cleanup : libuuid-2.37.4-1.amzn2023.0.3.x86_64 38/42 Cleanup : expat-2.5.0-1.amzn2023.0.3.x86_64 39/42 Cleanup : glibc-2.34-52.amzn2023.0.8.x86_64 40/42 Cleanup : glibc-minimal-langpack-2.34-52.amzn2023.0.8.x86_64 41/42 Cleanup : glibc-common-2.34-52.amzn2023.0.8.x86_64 42/42 Running scriptlet: glibc-common-2.34-52.amzn2023.0.8.x86_64 42/42 Verifying : amazon-linux-repo-cdn-2023.5.20240708-1.amzn2023.no 1/42 Verifying : amazon-linux-repo-cdn-2023.4.20240319-1.amzn2023.no 2/42 Verifying : curl-minimal-8.5.0-1.amzn2023.0.4.x86_64 3/42 Verifying : curl-minimal-8.5.0-1.amzn2023.0.2.x86_64 4/42 Verifying : dnf-4.14.0-1.amzn2023.0.5.noarch 5/42 Verifying : dnf-4.14.0-1.amzn2023.0.4.noarch 6/42 Verifying : dnf-data-4.14.0-1.amzn2023.0.5.noarch 7/42 Verifying : dnf-data-4.14.0-1.amzn2023.0.4.noarch 8/42 Verifying : expat-2.5.0-1.amzn2023.0.4.x86_64 9/42 Verifying : expat-2.5.0-1.amzn2023.0.3.x86_64 10/42 Verifying : glibc-2.34-52.amzn2023.0.10.x86_64 11/42 Verifying : glibc-2.34-52.amzn2023.0.8.x86_64 12/42 Verifying : glibc-common-2.34-52.amzn2023.0.10.x86_64 13/42 Verifying : glibc-common-2.34-52.amzn2023.0.8.x86_64 14/42 Verifying : glibc-minimal-langpack-2.34-52.amzn2023.0.10.x86_64 15/42 Verifying : glibc-minimal-langpack-2.34-52.amzn2023.0.8.x86_64 16/42 Verifying : krb5-libs-1.21-3.amzn2023.0.4.x86_64 17/42 Applying security updates using DNF and repository versions 465 Amazon Linux 2023 User Guide Verifying : krb5-libs-1.21-3.amzn2023.0.3.x86_64 18/42 Verifying : libblkid-2.37.4-1.amzn2023.0.4.x86_64 19/42 Verifying : libblkid-2.37.4-1.amzn2023.0.3.x86_64 20/42 Verifying : libcurl-minimal-8.5.0-1.amzn2023.0.4.x86_64 21/42 Verifying : libcurl-minimal-8.5.0-1.amzn2023.0.2.x86_64 22/42 Verifying : libmount-2.37.4-1.amzn2023.0.4.x86_64 23/42 Verifying : libmount-2.37.4-1.amzn2023.0.3.x86_64 24/42 Verifying : libnghttp2-1.59.0-3.amzn2023.0.1.x86_64 25/42 Verifying : libnghttp2-1.57.0-1.amzn2023.0.1.x86_64 26/42 Verifying : libsmartcols-2.37.4-1.amzn2023.0.4.x86_64 27/42 Verifying : libsmartcols-2.37.4-1.amzn2023.0.3.x86_64 28/42 Verifying : libuuid-2.37.4-1.amzn2023.0.4.x86_64 29/42 Verifying : libuuid-2.37.4-1.amzn2023.0.3.x86_64 30/42 Verifying : openssl-libs-1:3.0.8-1.amzn2023.0.12.x86_64 31/42 Verifying : openssl-libs-1:3.0.8-1.amzn2023.0.11.x86_64 32/42 Verifying : python3-3.9.16-1.amzn2023.0.8.x86_64 33/42 Verifying : python3-3.9.16-1.amzn2023.0.6.x86_64 34/42 Verifying : python3-dnf-4.14.0-1.amzn2023.0.5.noarch 35/42 Verifying : python3-dnf-4.14.0-1.amzn2023.0.4.noarch 36/42 Verifying : python3-libs-3.9.16-1.amzn2023.0.8.x86_64 37/42 Verifying : python3-libs-3.9.16-1.amzn2023.0.6.x86_64 38/42 Verifying : system-release-2023.5.20240708-1.amzn2023.noarch 39/42 Verifying : system-release-2023.4.20240319-1.amzn2023.noarch 40/42 Verifying : yum-4.14.0-1.amzn2023.0.5.noarch 41/42 Verifying : yum-4.14.0-1.amzn2023.0.4.noarch 42/42 Upgraded: amazon-linux-repo-cdn-2023.5.20240708-1.amzn2023.noarch curl-minimal-8.5.0-1.amzn2023.0.4.x86_64 dnf-4.14.0-1.amzn2023.0.5.noarch dnf-data-4.14.0-1.amzn2023.0.5.noarch expat-2.5.0-1.amzn2023.0.4.x86_64 glibc-2.34-52.amzn2023.0.10.x86_64 glibc-common-2.34-52.amzn2023.0.10.x86_64 glibc-minimal-langpack-2.34-52.amzn2023.0.10.x86_64 krb5-libs-1.21-3.amzn2023.0.4.x86_64 libblkid-2.37.4-1.amzn2023.0.4.x86_64 libcurl-minimal-8.5.0-1.amzn2023.0.4.x86_64 libmount-2.37.4-1.amzn2023.0.4.x86_64 libnghttp2-1.59.0-3.amzn2023.0.1.x86_64 libsmartcols-2.37.4-1.amzn2023.0.4.x86_64 libuuid-2.37.4-1.amzn2023.0.4.x86_64 openssl-libs-1:3.0.8-1.amzn2023.0.12.x86_64 python3-3.9.16-1.amzn2023.0.8.x86_64 Applying security updates using DNF and repository versions 466 Amazon Linux 2023 User Guide python3-dnf-4.14.0-1.amzn2023.0.5.noarch python3-libs-3.9.16-1.amzn2023.0.8.x86_64 system-release-2023.5.20240708-1.amzn2023.noarch yum-4.14.0-1.amzn2023.0.5.noarch Complete! bash-5.2# To discover AL2023 updates, do one
al2023-ug-101	al2023-ug.pdf	101	Verifying : libuuid-2.37.4-1.amzn2023.0.4.x86_64 29/42 Verifying : libuuid-2.37.4-1.amzn2023.0.3.x86_64 30/42 Verifying : openssl-libs-1:3.0.8-1.amzn2023.0.12.x86_64 31/42 Verifying : openssl-libs-1:3.0.8-1.amzn2023.0.11.x86_64 32/42 Verifying : python3-3.9.16-1.amzn2023.0.8.x86_64 33/42 Verifying : python3-3.9.16-1.amzn2023.0.6.x86_64 34/42 Verifying : python3-dnf-4.14.0-1.amzn2023.0.5.noarch 35/42 Verifying : python3-dnf-4.14.0-1.amzn2023.0.4.noarch 36/42 Verifying : python3-libs-3.9.16-1.amzn2023.0.8.x86_64 37/42 Verifying : python3-libs-3.9.16-1.amzn2023.0.6.x86_64 38/42 Verifying : system-release-2023.5.20240708-1.amzn2023.noarch 39/42 Verifying : system-release-2023.4.20240319-1.amzn2023.noarch 40/42 Verifying : yum-4.14.0-1.amzn2023.0.5.noarch 41/42 Verifying : yum-4.14.0-1.amzn2023.0.4.noarch 42/42 Upgraded: amazon-linux-repo-cdn-2023.5.20240708-1.amzn2023.noarch curl-minimal-8.5.0-1.amzn2023.0.4.x86_64 dnf-4.14.0-1.amzn2023.0.5.noarch dnf-data-4.14.0-1.amzn2023.0.5.noarch expat-2.5.0-1.amzn2023.0.4.x86_64 glibc-2.34-52.amzn2023.0.10.x86_64 glibc-common-2.34-52.amzn2023.0.10.x86_64 glibc-minimal-langpack-2.34-52.amzn2023.0.10.x86_64 krb5-libs-1.21-3.amzn2023.0.4.x86_64 libblkid-2.37.4-1.amzn2023.0.4.x86_64 libcurl-minimal-8.5.0-1.amzn2023.0.4.x86_64 libmount-2.37.4-1.amzn2023.0.4.x86_64 libnghttp2-1.59.0-3.amzn2023.0.1.x86_64 libsmartcols-2.37.4-1.amzn2023.0.4.x86_64 libuuid-2.37.4-1.amzn2023.0.4.x86_64 openssl-libs-1:3.0.8-1.amzn2023.0.12.x86_64 python3-3.9.16-1.amzn2023.0.8.x86_64 Applying security updates using DNF and repository versions 466 Amazon Linux 2023 User Guide python3-dnf-4.14.0-1.amzn2023.0.5.noarch python3-libs-3.9.16-1.amzn2023.0.8.x86_64 system-release-2023.5.20240708-1.amzn2023.noarch yum-4.14.0-1.amzn2023.0.5.noarch Complete! bash-5.2# To discover AL2023 updates, do one or more of the following: • Run the dnf check-update command. This checks for any unapplied updates in the version of Amazon Linux which you are locked to. This may show updates if you updated only the system- release package, moving what version of the repositories the instance is locked to but not applying any of the updates available in it. • Subscribe to the Amazon Linux repository update SNS topic (arn:aws:sns:us- east-1:137112412989:amazon-linux-2023-ami-updates). For more information, see Subscribing to an Amazon SNS topic in the Amazon Simple Notiﬁcation Service Developer Guide. • Regularly refer to the AL2023 release notes. • Discover new versions by Checking for newer repository versions with dnf check-release- update. Important New versions of AL2023 containing security updates are released frequently. Be sure to keep up to date with relevant security patches. Automatic service restart after (security) updates Amazon Linux now ships with the smart-restart package. Smart-restart restarts systemd services on system updates whenever a package is installed or deleted using the systems package manager. This occurs whenever dnf (update\|upgrade\|downgrade) is executed. Smart-restart uses the needs-restarting package from dnf-utils and a custom denylisting mechanism to determine which services need to be restarted and whether a system reboot is advised. If a system reboot is advised, a reboot hint marker ﬁle is generated (/run/ smart-restart/reboot-hint-marker). Automatic service restart after (security) updates 467 Amazon Linux 2023 To install smart-restart User Guide Run the following DNF command (as you would with any other package). $ sudo dnf install smart-restart After the installation, the subsequent transactions will trigger the smart-restart logic. Denylist Smart-restart can be instructed to block certain services from being restarted. The blocked services won't contribute to the decision of whether a reboot is required. To block additional services, add a ﬁle with the suﬃx -denylist in /etc/smart-restart-conf.d/ as shown in the following example. $ cat /etc/smart-restart-conf.d/custom-denylist # Some comments myservice.service Note All -denylist ﬁles are read and evaluated when making the decision of whether a reboot is required. Custom hooks In addition to denylisting, smart-restart provides a mechanism to run custom scripts before and after the attempts to restart the service. The custom scripts can be used to manually perform preparation steps or to inform other components of a remaining or completed restart. All scripts in /etc/smart-restart-conf.d/ with the suﬃx -pre-restart or -post- restartare executed. If the order is important, preﬁx all of the scripts with a number to ensure the execution order as shown in the following example. $ ls /etc/smart-restart-conf.d/-pre-restart 001-my-script-pre-restart 002-some-other-script-pre-restart Automatic service restart after (security) updates 468 Amazon Linux 2023 User Guide When is a reboot required to apply security updates? In some situations, Amazon Linux requires a reboot to apply updates: • Updates to the Linux kernel package require a reboot to activate the new kernel with latest security updates. Kernel livepatching may allow you to postpone security updates for a limited period of time. For details, consult Kernel Live Patching on AL2023. • On EC2 Metal instances, Amazon Linux provides microcode updates (through the microcode_ctl package for Intel CPUs and the amd-ucode-firmware package for AMD CPUs.) These microcode updates will only be activated on subsequent instance reboots. For virtualized EC2 instances, the underlying AWS Nitro system handles microcode updates for you. • Some running systemd services will only function correctly after a full system restart. The smart-restart mechanism will inform you about such situations by leaving reboot hints. See Automatic service restart after (security) updates. Launching an instance with the latest repository version enabled You can add DNF commands to a user-data script to control what RPM packages are installed on an Amazon Linux AMI when it's launched. In the following example, a user-data script is used to make sure that any instance launched with the user-data script has the same package updates installed. #!/bin/bash dnf upgrade --releasever=2023.0.20230210 # Additional setup and install commands below dnf install httpd php7.4 mysql80 You must run this script as superuser (root). To do this, run the following command. $ sudo sh -c "bash nameofscript.sh" For more information, see User data and shell scripts in the Amazon EC2 User Guide. Note Instead of using a user-data script, launch the latest Amazon Linux AMI or a custom
al2023-ug-102	al2023-ug.pdf	102	Amazon Linux AMI when it's launched. In the following example, a user-data script is used to make sure that any instance launched with the user-data script has the same package updates installed. #!/bin/bash dnf upgrade --releasever=2023.0.20230210 # Additional setup and install commands below dnf install httpd php7.4 mysql80 You must run this script as superuser (root). To do this, run the following command. $ sudo sh -c "bash nameofscript.sh" For more information, see User data and shell scripts in the Amazon EC2 User Guide. Note Instead of using a user-data script, launch the latest Amazon Linux AMI or a custom AMI that's based on the Amazon Linux AMI. The latest Amazon Linux AMI has all the necessary updates installed and is conﬁgured to point at a particular repository version. When is a reboot required to apply security updates? 469 Amazon Linux 2023 User Guide Getting package support information AL2023 incorporates many diﬀerent open-source software projects. Each of these projects is managed independently from Amazon Linux and have diﬀerent release and end-of-support schedules. To provide you with Amazon Linux speciﬁc information about these diﬀerent packages, the DNF supportinfo plugin provides metadata about a package. In the following example, the dnf supportinfo command returns metadata for the glibc package. $ sudo dnf supportinfo --pkg glibc Last metadata expiration check: 0:07:56 ago on Wed Mar 1 23:21:49 2023. Name : glibc Version : 2.34-52.amzn2023.0.2 State : installed Support Status : supported Support Periods : from 2023-03-15 : supported : from 2028-03-15 : unsupported Support Statement : Amazon Linux 2023 End Of Life Link : https://aws.amazon.com/amazon-linux-ami/faqs/ Other Info : This is the support statement for AL2023. The ...: end of life of Amazon Linux 2023 would be March 2028. ...: From this point, the Amazon Linux 2023 packages (listed ...: below) will no longer, receive any updates from AWS. Package support information is also available in the support statements section of the AL2023 Release Notes. Checking for newer repository versions with dnf check-release- update In an AL2023 instance, you can use the DNF utility to manage repositories and apply updated RPM packages. These packages are available in the Amazon Linux repositories. You can use the DNF command dnf check-release-update to check for new versions of the DNF repository. Note AL2023 container images do not include the dnf check-release-update command by default. $ dnf check-release-update No such command: check-release-update. Please use /usr/bin/dnf --help Getting package support information 470 Amazon Linux 2023 User Guide It could be a DNF plugin command, try: "dnf install 'dnf-command(check-release- update)'" When dnf install 'dnf-command(check-release-update)' is run, dnf will install the package which provides the check-release-update command, which is the dnf- plugin-release-notification package. In the below example, the -q argument is given to dnf for it to have quiet output. $ dnf -y -q install 'dnf-command(check-release-update)' Installed: dnf-plugin-release-notification-1.2-1.amzn2023.0.2.noarch In non-containerized environments such as an Amazon EC2 instance, the check-release- update command is included by default. $ sudo dnf check-release-update WARNING: A newer release of "Amazon Linux" is available. Available Versions: Version 2023.0.20230210: Run the following command to update to 2023.0.20230210: dnf upgrade --releasever=2023.0.20230210 Release notes: https://docs.aws.amazon.com/linux/al2023/release-notes/relnotes.html This returns a full list of all the newer versions of the DNF repositories that are available. If nothing's returned, this means that DNF is currently conﬁgured to use the latest available version. The version of the currently installed system-release package sets the releasever DNF variable. To check the current repository version, run the following command. $ rpm -q system-release --qf "%{VERSION}\n" When you run DNF package transactions (such as install, update, or remove commands), a warning message notiﬁes you of any new repository versions. For example, if you install the httpd package dnf check-release-update 471 Amazon Linux 2023 User Guide on an instance that was launched from an older version of AL2023, the following output is returned. $ sudo dnf install httpd -y Last metadata expiration check: 0:16:52 ago on Wed Mar 1 23:21:49 2023. Dependencies resolved. ==================================================================== Package Arch Version Repository Size ==================================================================== Installing: httpd x86_64 2.4.54-3.amzn2023.0.4 amazonlinux 46 k Installing dependencies: apr x86_64 1.7.2-2.amzn2023.0.2 amazonlinux 129 k apr-util x86_64 1.6.3-1.amzn2023.0.1 amazonlinux 98 k generic-logos-httpd noarch 18.0.0-12.amzn2023.0.3 amazonlinux 19 k httpd-core x86_64 2.4.54-3.amzn2023.0.4 amazonlinux 1.3 M httpd-filesystem noarch 2.4.54-3.amzn2023.0.4 amazonlinux 13 k httpd-tools x86_64 2.4.54-3.amzn2023.0.4 amazonlinux 80 k libbrotli x86_64 1.0.9-4.amzn2023.0.2 amazonlinux 315 k mailcap noarch 2.1.49-3.amzn2023.0.3 amazonlinux 33 k Installing weak dependencies: apr-util-openssl x86_64 1.6.3-1.amzn2023.0.1 amazonlinux 17 k mod_http2 x86_64 1.15.24-1.amzn2023.0.3 amazonlinux 152 k mod_lua x86_64 2.4.54-3.amzn2023.0.4 amazonlinux 60 k Transaction Summary ==================================================================== Install 12 Packages Total download size: 2.3 M Installed size: 6.8 M Downloading Packages: (1/12): apr-util-openssl-1.6.3-1.am 212 kB/s \| 17 kB 00:00 (2/12): apr-1.7.2-2.amzn2023.0.2.x8 1.1 MB/s \| 129 kB 00:00 (3/12): httpd-core-2.4.54-3.amzn202 8.9 MB/s \| 1.3 MB 00:00 (4/12): mod_http2-1.15.24-1.amzn202 1.9 MB/s \| 152 kB 00:00 (5/12): apr-util-1.6.3-1.amzn2023.0 1.7 MB/s \| 98 kB 00:00 (6/12): mod_lua-2.4.54-3.amzn2023.0 1.4 MB/s \|
al2023-ug-103	al2023-ug.pdf	103	x86_64 2.4.54-3.amzn2023.0.4 amazonlinux 80 k libbrotli x86_64 1.0.9-4.amzn2023.0.2 amazonlinux 315 k mailcap noarch 2.1.49-3.amzn2023.0.3 amazonlinux 33 k Installing weak dependencies: apr-util-openssl x86_64 1.6.3-1.amzn2023.0.1 amazonlinux 17 k mod_http2 x86_64 1.15.24-1.amzn2023.0.3 amazonlinux 152 k mod_lua x86_64 2.4.54-3.amzn2023.0.4 amazonlinux 60 k Transaction Summary ==================================================================== Install 12 Packages Total download size: 2.3 M Installed size: 6.8 M Downloading Packages: (1/12): apr-util-openssl-1.6.3-1.am 212 kB/s \| 17 kB 00:00 (2/12): apr-1.7.2-2.amzn2023.0.2.x8 1.1 MB/s \| 129 kB 00:00 (3/12): httpd-core-2.4.54-3.amzn202 8.9 MB/s \| 1.3 MB 00:00 (4/12): mod_http2-1.15.24-1.amzn202 1.9 MB/s \| 152 kB 00:00 (5/12): apr-util-1.6.3-1.amzn2023.0 1.7 MB/s \| 98 kB 00:00 (6/12): mod_lua-2.4.54-3.amzn2023.0 1.4 MB/s \| 60 kB 00:00 (7/12): httpd-2.4.54-3.amzn2023.0.4 1.5 MB/s \| 46 kB 00:00 (8/12): libbrotli-1.0.9-4.amzn2023. 4.4 MB/s \| 315 kB 00:00 (9/12): mailcap-2.1.49-3.amzn2023.0 753 kB/s \| 33 kB 00:00 (10/12): httpd-tools-2.4.54-3.amzn2 978 kB/s \| 80 kB 00:00 dnf check-release-update 472 Amazon Linux 2023 User Guide (11/12): httpd-filesystem-2.4.54-3. 210 kB/s \| 13 kB 00:00 (12/12): generic-logos-httpd-18.0.0 439 kB/s \| 19 kB 00:00 -------------------------------------------------------------------- Total 6.6 MB/s \| 2.3 MB 00:00 Running transaction check Transaction check succeeded. Running transaction test Transaction test succeeded. Running transaction Preparing : 1/1 Installing : apr-1.7.2-2.amzn2023.0.2.x86_64 1/12 Installing : apr-util-openssl-1.6.3-1.amzn2023.0.1. 2/12 Installing : apr-util-1.6.3-1.amzn2023.0.1.x86_64 3/12 Installing : mailcap-2.1.49-3.amzn2023.0.3.noarch 4/12 Installing : httpd-tools-2.4.54-3.amzn2023.0.4.x86_ 5/12 Installing : generic-logos-httpd-18.0.0-12.amzn2023 6/12 Running scriptlet: httpd-filesystem-2.4.54-3.amzn2023.0.4 7/12 Installing : httpd-filesystem-2.4.54-3.amzn2023.0.4 7/12 Installing : httpd-core-2.4.54-3.amzn2023.0.4.x86_6 8/12 Installing : mod_http2-1.15.24-1.amzn2023.0.3.x86_6 9/12 Installing : libbrotli-1.0.9-4.amzn2023.0.2.x86_64 10/12 Installing : mod_lua-2.4.54-3.amzn2023.0.4.x86_64 11/12 Installing : httpd-2.4.54-3.amzn2023.0.4.x86_64 12/12 Running scriptlet: httpd-2.4.54-3.amzn2023.0.4.x86_64 12/12 Verifying : apr-1.7.2-2.amzn2023.0.2.x86_64 1/12 Verifying : apr-util-openssl-1.6.3-1.amzn2023.0.1. 2/12 Verifying : httpd-core-2.4.54-3.amzn2023.0.4.x86_6 3/12 Verifying : mod_http2-1.15.24-1.amzn2023.0.3.x86_6 4/12 Verifying : apr-util-1.6.3-1.amzn2023.0.1.x86_64 5/12 Verifying : mod_lua-2.4.54-3.amzn2023.0.4.x86_64 6/12 Verifying : libbrotli-1.0.9-4.amzn2023.0.2.x86_64 7/12 Verifying : httpd-2.4.54-3.amzn2023.0.4.x86_64 8/12 Verifying : httpd-tools-2.4.54-3.amzn2023.0.4.x86_ 9/12 Verifying : mailcap-2.1.49-3.amzn2023.0.3.noarch 10/12 Verifying : httpd-filesystem-2.4.54-3.amzn2023.0.4 11/12 Verifying : generic-logos-httpd-18.0.0-12.amzn2023 12/12 Installed: apr-1.7.2-2.amzn2023.0.2.x86_64 apr-util-1.6.3-1.amzn2023.0.1.x86_64 apr-util-openssl-1.6.3-1.amzn2023.0.1.x86_64 generic-logos-httpd-18.0.0-12.amzn2023.0.3.noarch httpd-2.4.54-3.amzn2023.0.4.x86_64 httpd-core-2.4.54-3.amzn2023.0.4.x86_64 dnf check-release-update 473 Amazon Linux 2023 User Guide httpd-filesystem-2.4.54-3.amzn2023.0.4.noarch httpd-tools-2.4.54-3.amzn2023.0.4.x86_64 libbrotli-1.0.9-4.amzn2023.0.2.x86_64 mailcap-2.1.49-3.amzn2023.0.3.noarch mod_http2-1.15.24-1.amzn2023.0.3.x86_64 mod_lua-2.4.54-3.amzn2023.0.4.x86_64 Complete! Adding, enabling, or disabling new repositories Warning Only add repositories designed to be used with AL2023. While repositories designed for other distributions may work today, there is no guarantee they will continue to do so with any package update in AL2023 or the repository not designed for use with AL2023. To install a package from a diﬀerent repository than the default Amazon Linux repositories, you will need to conﬁgure the DNF package management system to know where the repostiory is To tell dnf about a package repository, add the repository information to a conﬁguration ﬁle for that repository in the /etc/yum.repos.d/ directory. Many third-party repositories provide either the conﬁguration ﬁle content or an installable package which includes the conﬁguration ﬁle. Note While repositories can be conﬁgured directly in the /etc/dnf/dnf.conf ﬁle, this is not recommended. It is recommended that each repository be conﬁgured in its own ﬁle in / etc/yum.repos.d/. To ﬁnd out what repositories are currently enabled, you can run the following command: $ dnf repolist all --verbose Loaded plugins: builddep, changelog, config-manager, copr, debug, debuginfo-install, download, generate_completion_cache, groups-manager, needs-restarting, playground, release-notification, repoclosure, repodiff, repograph, repomanage, reposync, supportinfo Adding, enabling, or disabling new repositories 474 Amazon Linux 2023 DNF version: 4.12.0 cachedir: /var/cache/dnf Last metadata expiration check: 0:00:02 ago on Wed Mar 1 23:40:15 2023. User Guide Repo-id : amazonlinux Repo-name : Amazon Linux 2023 repository Repo-status : enabled Repo-revision : 1677203368 Repo-updated : Fri Feb 24 01:49:28 2023 Repo-pkgs : 12632 Repo-available-pkgs: 12632 Repo-size : 12 G Repo-mirrors : https://al2023-repos-us-west-2-de612dc2.s3.dualstack.us- west-2.amazonaws.com/core/mirrors/2023.0.20230222/x86_64/mirror.list Repo-baseurl : https://al2023-repos-us-west-2-de612dc2.s3.dualstack.us- west-2.amazonaws.com/core/guids/ cf9296325a6c46ff40c775a8e2d632c4c3fd9d9164014ce3304715d61b90ca8e/x86_64/ : (0 more) Repo-expire : 172800 second(s) (last: Wed Mar 1 23:40:15 : 2023) Repo-filename : /etc/yum.repos.d/amazonlinux.repo Repo-id : amazonlinux-debuginfo Repo-name : Amazon Linux 2023 repository - Debug Repo-status : disabled Repo-mirrors : https://al2023-repos-us-west-2-de612dc2.s3.dualstack.us- west-2.amazonaws.com/core/mirrors/2023.0.20230222/debuginfo/x86_64/mirror.list Repo-expire : 21600 second(s) (last: unknown) Repo-filename : /etc/yum.repos.d/amazonlinux.repo Repo-id : amazonlinux-source Repo-name : Amazon Linux 2023 repository - Source packages Repo-status : disabled Repo-mirrors : https://al2023-repos-us-west-2-de612dc2.s3.dualstack.us- west-2.amazonaws.com/core/mirrors/2023.0.20230222/SRPMS/mirror.list Repo-expire : 21600 second(s) (last: unknown) Repo-filename : /etc/yum.repos.d/amazonlinux.repo Repo-id : kernel-livepatch Repo-name : Amazon Linux 2023 Kernel Livepatch repository Repo-status : disabled Repo-mirrors : https://al2023-repos-us-west-2-de612dc2.s3.dualstack.us- west-2.amazonaws.com/kernel-livepatch/mirrors/al2023/x86_64/mirror.list Repo-expire : 172800 second(s) (last: unknown) Repo-filename : /etc/yum.repos.d/kernel-livepatch.repo Adding, enabling, or disabling new repositories 475 Amazon Linux 2023 User Guide Repo-id : kernel-livepatch-source Repo-name : Amazon Linux 2023 Kernel Livepatch repository - : Source packages Repo-status : disabled Repo-mirrors : https://al2023-repos-us-west-2-de612dc2.s3.dualstack.us- west-2.amazonaws.com/kernel-livepatch/mirrors/al2023/SRPMS/mirror.list Repo-expire : 21600 second(s) (last: unknown) Repo-filename : /etc/yum.repos.d/kernel-livepatch.repo Total packages: 12632 Note If you don't add the --verbose option ﬂag, the output only includes the Repo-id, Repo- name, and Repo-status information. To add a yum repository to /etc/yum.repos.d directory: 1. Find the location of the .repo ﬁle. In this example, the .repo ﬁle is at https:// www.example.com/repository.repo. 2. Add the repository with the dnf config-manager command. $ sudo dnf config-manager --add-repo https://www.example.com/repository.repo Loaded plugins: priorities, update-motd, upgrade-helper adding repo from: https://www.example.com/repository.repo grabbing file https://www.example.com/repository.repo to /etc/ yum.repos.d/repository.repo repository.repo \| 4.0 kB 00:00 repo saved to /etc/yum.repos.d/repository.repo After you
al2023-ug-104	al2023-ug.pdf	104	west-2.amazonaws.com/kernel-livepatch/mirrors/al2023/SRPMS/mirror.list Repo-expire : 21600 second(s) (last: unknown) Repo-filename : /etc/yum.repos.d/kernel-livepatch.repo Total packages: 12632 Note If you don't add the --verbose option ﬂag, the output only includes the Repo-id, Repo- name, and Repo-status information. To add a yum repository to /etc/yum.repos.d directory: 1. Find the location of the .repo ﬁle. In this example, the .repo ﬁle is at https:// www.example.com/repository.repo. 2. Add the repository with the dnf config-manager command. $ sudo dnf config-manager --add-repo https://www.example.com/repository.repo Loaded plugins: priorities, update-motd, upgrade-helper adding repo from: https://www.example.com/repository.repo grabbing file https://www.example.com/repository.repo to /etc/ yum.repos.d/repository.repo repository.repo \| 4.0 kB 00:00 repo saved to /etc/yum.repos.d/repository.repo After you install a repository, you must enable it as described in the next procedure. To enable a yum repository in /etc/yum.repos.d, use the dnf config-manager command with the --enable ﬂag and repository name. $ sudo dnf config-manager --enable repository Adding, enabling, or disabling new repositories 476 Amazon Linux 2023 Note User Guide To disable a repository, use the same command syntax, but replace --enable with -- disable in the command. Adding repositories with cloud-init In addition to adding a repository using the previous method, you can also add a new repository using the cloud-init framework. To add a new package repository, we recommend the use of the following template. Consider saving this ﬁle locally. #cloud-config yum_repos: repository.repo: baseurl: https://www.example.com/ enabled: true gpgcheck: true gpgkey: file:///etc/pki/rpm-gpg/RPM-GPG-KEY-EXAMPLE name: Example Repository Note One advantage to using cloud-init is that you can add a packages: section to your conﬁguration ﬁle. In this section, you can include the names of the packages that you want to install. You can install packages from either the default repository or the new repository that you added in the cloud-config ﬁle. For more speciﬁc information about the structure of the YAML ﬁle, see Adding a YUM repository in the cloud-init documentation. After you set up the YAML format ﬁle, you can run it in the cloud-init framework in the AWS CLI. Make sure to include the --userdata option and the name of the .yml ﬁle to call the desired operations. $ aws ec2 run-instances \ --image-id \ Adding repositories with cloud-init 477 Amazon Linux 2023 User Guide resolve:ssm:/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-default-x86_64 \ --instance-type m5.xlarge \ --region us-east-1 \ --key-name aws-key-us-east-1 \ --security-group-ids sg-004a7650 \ --user-data file://cloud-config.yml Kernel Live Patching on AL2023 You can use Kernel Live Patching for AL2023 to apply speciﬁc security vulnerability and critical bug patches to a running Linux kernel without rebooting or disrupting running applications. In addition, Kernel Live Patching can help improve your application's availability while applying these ﬁxes until the system can be rebooted. AWS releases two types of kernel live patches for AL2023: • Security updates – Include updates for Linux common vulnerabilities and exposures (CVE). These updates are typically rated as important or critical using the Amazon Linux Security Advisory ratings. They generally map to a Common Vulnerability Scoring System (CVSS) score of 7 and higher. In some cases, AWS might provide updates before a CVE is assigned. In these cases, the patches might appear as bug ﬁxes. • Bug ﬁxes – Include ﬁxes for critical bugs and stability issues that aren't associated with CVEs. AWS provides kernel live patches for an AL2023 kernel version for up to 3 months after its release. After this period, you must update to a later kernel version to continue to receive kernel live patches. AL2023 kernel live patches are made available as signed RPM packages in the existing AL2023 repositories. The patches can be installed on individual instances using existing DNF package manager workﬂows. Or, they can be installed on a group of managed instances using AWS Systems Manager. Kernel Live Patching on AL2023 is provided at no additional cost. Topics • Limitations • Supported conﬁgurations and prerequisites • Work with Kernel Live Patching Kernel Live Patching 478 Amazon Linux 2023 Limitations User Guide While applying a kernel live patch, you can't perform hibernation, use advanced debugging tools (such as SystemTap, kprobes, and eBPF-based tools), or access ftrace output ﬁles used by the Kernel Live Patching infrastructure. Note Due to technical limitations, some issues cannot be addressed with live patching. Because of that, these ﬁxes will not be shipped in the kernel live patch package but only in the native kernel package update. You can install the native kernel package and update and reboot the system to activate the patches as usual. Supported conﬁgurations and prerequisites Kernel Live Patching is supported on Amazon EC2 instances and on-premises virtual machines that run AL2023. To use Kernel Live Patching on AL2023, you must use the following: • A 64-bit x86_64 or ARM64 architecture • Kernel version 6.1 Policy requirements To download packages from AL2023 repositories, Amazon EC2 needs access to service owned Amazon S3 buckets. If you are using a Amazon Virtual Private Cloud (VPC) endpoint for Amazon S3 in
al2023-ug-105	al2023-ug.pdf	105	the native kernel package update. You can install the native kernel package and update and reboot the system to activate the patches as usual. Supported conﬁgurations and prerequisites Kernel Live Patching is supported on Amazon EC2 instances and on-premises virtual machines that run AL2023. To use Kernel Live Patching on AL2023, you must use the following: • A 64-bit x86_64 or ARM64 architecture • Kernel version 6.1 Policy requirements To download packages from AL2023 repositories, Amazon EC2 needs access to service owned Amazon S3 buckets. If you are using a Amazon Virtual Private Cloud (VPC) endpoint for Amazon S3 in your environment, ensure that your VPC endpoint policy allows access to those public buckets. The following table describes the Amazon S3 bucket that Amazon EC2 might need to access for Kernel Live Patching. S3 bucket ARN Description arn:aws:s3:::al2023-repos-region-de612dc2/ * Amazon S3 bucket containing AL2023 repositories Limitations 479 Amazon Linux 2023 User Guide Work with Kernel Live Patching You can enable and use Kernel Live Patching on individual instances using the command line on the instance itself. Alternatively, you can enable and use Kernel Live Patching on a group of managed instances using AWS Systems Manager. The following sections explain how to enable and use Kernel Live Patching on individual instances using the command line. For more information about enabling and using Kernel Live Patching on a group of managed instances, see Use Kernel Live Patching on AL2023 instances in the AWS Systems Manager User Guide. Topics • Enable Kernel Live Patching • View the available kernel live patches • Apply kernel live patches • View the applied kernel live patches • Disable Kernel Live Patching Enable Kernel Live Patching Kernel Live Patching is disabled by default on AL2023. To use live patching, you must install the DNF plugin for Kernel Live Patching and enable the live patching functionality. To enable Kernel Live Patching 1. Kernel live patches are available for AL2023 with kernel version 6.1. To check your kernel version, run the following command. $ sudo dnf list kernel 2. Install the DNF plugin for Kernel Live Patching. $ sudo dnf install -y kpatch-dnf 3. Enable the DNF plugin for Kernel Live Patching. Work with Kernel Live Patching 480 Amazon Linux 2023 User Guide $ sudo dnf kernel-livepatch -y auto This command also installs the latest version of the kernel live patch RPM from the conﬁgured repositories. 4. To conﬁrm that the DNF plugin for kernel live patching installed successfully, run the following command. When you enable Kernel Live Patching, an empty kernel live patch RPM is automatically applied. If Kernel Live Patching was successfully enabled, this command returns a list that includes the initial empty kernel live patch RPM (and another RPM setting up the DNF repository containing the livepatches). $ sudo rpm -qa \| grep kernel-livepatch kernel-livepatch-repo-s3-2023.7.20250428-0.amzn2023.noarch kernel-livepatch-6.1.134-150.224-1.0-0.amzn2023.x86_64 5. Install the kpatch package. $ sudo dnf install -y kpatch-runtime 6. Update the kpatch service if it was previously installed. $ sudo dnf upgrade kpatch-runtime 7. Start the kpatch service. This service loads all of the kernel live patches upon initialization or at boot. $ sudo systemctl enable kpatch.service && sudo systemctl start kpatch.service View the available kernel live patches Amazon Linux security alerts are published to the Amazon Linux Security Center. For more information about the AL2023 security alerts, including alerts for kernel live patches, see the Amazon Linux Security Center. Kernel live patches are preﬁxed with ALASLIVEPATCH. The Amazon Linux Security Center might not list kernel live patches that address bugs. You can also discover the available kernel live patches for advisories and CVEs using the command line. Work with Kernel Live Patching 481 Amazon Linux 2023 User Guide To list all available kernel live patches for advisories Use the following command. $ sudo dnf updateinfo list Last metadata expiration check: 1:06:23 ago on Mon 13 Feb 2023 09:28:19 PM UTC. ALAS2LIVEPATCH-2021-123 important/Sec. kernel- livepatch-6.1.12-17.42-1.0-4.amzn2023.x86_64 ALAS2LIVEPATCH-2022-124 important/Sec. kernel- livepatch-6.1.12-17.42-1.0-3.amzn2023.x86_64 To list all available kernel live patches for CVEs Use the following command. $ sudo dnf updateinfo list cves Last metadata expiration check: 1:07:26 ago on Mon 13 Feb 2023 09:28:19 PM UTC. CVE-2022-0123 important/Sec. kernel-livepatch-6.1.12-17.42-1.0-4.amzn2023.x86_64 CVE-2022-3210 important/Sec. kernel-livepatch-6.1.12-17.42-1.0-3.amzn2023.x86_64 Apply kernel live patches You apply kernel live patches using the DNF package manager in the same way that you apply regular updates. The DNF plugin for Kernel Live Patching manages the kernel live patches that are available to be applied. Tip We recommend that you update your kernel regularly using Kernel Live Patching to ensure that it receives speciﬁc important and critical security ﬁxes until the system can be rebooted. Please also check if additional ﬁxes have been made available to the native kernel package that cannot be deployed as live patches and update and reboot into the kernel update for those cases. You can choose to apply
al2023-ug-106	al2023-ug.pdf	106	using the DNF package manager in the same way that you apply regular updates. The DNF plugin for Kernel Live Patching manages the kernel live patches that are available to be applied. Tip We recommend that you update your kernel regularly using Kernel Live Patching to ensure that it receives speciﬁc important and critical security ﬁxes until the system can be rebooted. Please also check if additional ﬁxes have been made available to the native kernel package that cannot be deployed as live patches and update and reboot into the kernel update for those cases. You can choose to apply a speciﬁc kernel live patch, or to apply any available kernel live patches along with your regular security updates. Work with Kernel Live Patching 482 Amazon Linux 2023 User Guide To apply a speciﬁc kernel live patch 1. Get the kernel live patch version using one of the commands described in View the available kernel live patches. 2. Apply the kernel live patch for your AL2023 kernel. $ sudo dnf install kernel-livepatch-kernel_version-package_version.amzn2023.x86_64 For example, the following command applies a kernel live patch for AL2023 kernel version 6.1.12-17.42 $ sudo dnf install kernel-livepatch-6.1.12-17.42-1.0-4.amzn2023.x86_64 To apply any available kernel live patches along with your regular security updates Use the following command. $ sudo dnf upgrade --security Omit the --security option to include bug ﬁxes. Important • The kernel version isn't updated after applying kernel live patches. The version is only updated to the new version after the instance is rebooted. • An AL2023 kernel receives kernel live patches for 3 months. After this period, no new kernel live patches are released for that kernel version. • To continue to receive kernel live patches after 3 months, you must reboot the instance to move to the new kernel version. The instance continues to receive kernel live patches for the next 3 months after you update it. • To check the support window for your kernel version, run the following command: $ sudo dnf kernel-livepatch support The current version of the Linux kernel you are running will no longer receive live patches after 2025-07-22. Work with Kernel Live Patching 483 Amazon Linux 2023 User Guide View the applied kernel live patches To view the applied kernel live patches Use the following command. $ sudo kpatch list Loaded patch modules: livepatch_CVE_2022_36946 [enabled] Installed patch modules: livepatch_CVE_2022_36946 (6.1.57-29.131.amzn2023.x86_64) livepatch_CVE_2022_36946 (6.1.57-30.131.amzn2023.x86_64) The command returns a list of the loaded and installed security update kernel live patches. The following is example output. Note A single kernel live patch can include and install multiple live patches. Disable Kernel Live Patching If you no longer need to use Kernel Live Patching, you can disable it at any time. • Disable the use of livepatches: 1. Disable the plugin: $ sudo dnf kernel-livepatch manual 2. Disable the kpatch service: $ sudo systemctl disable --now kpatch.service • Fully remove the livepatch tools: 1. Remove the plugin: $ sudo dnf remove kpatch-dnf 2. Remove kpatch-runtime: Work with Kernel Live Patching 484 Amazon Linux 2023 User Guide $ sudo dnf remove kpatch-runtime 3. Remove any installed livepatches: $ sudo dnf remove kernel-livepatch\* Updating the Linux kernel on AL2023 Topics • Linux kernel versions on AL2023 • Updating AL2023 to kernel 6.12 • AL2023 kernels - Frequently Asked Questions Linux kernel versions on AL2023 AL2023 regularly includes new kernel versions based on Long-Term Support (LTS) versions of the Linux kernel. AL2023 was originally released in March 2023 with kernel 6.1. In April 2025, AL2023 added support for Linux kernel 6.12. This kernel added new features including EEVDF scheduling, FUSE passthrough I/O support, a new Futex API, and improvements in eBPF. Kernel 6.12 also allows a userspace program to secure itself at runtime using user-space shadow stacks and memory sealing. Updating AL2023 to kernel 6.12 You can run AL2023 with kernel 6.12 either by selecting an AMI with kernel 6.12 pre-installed or by upgrading an existing AL2023 EC2 instance. Running an AL2023 kernel 6.12 AMI You may select to run an AL2023 AMI with kernel 6.12 pre-installed through the AWS Console or by querying SSM for speciﬁc parameters. The SSM keys to query start with /aws/service/ami- amazon-linux-latest/ followed by one of • al2023-ami-kernel-6.12-arm64 for arm64 architecture Kernel Updates 485 Amazon Linux 2023 User Guide • al2023-ami-minimal-kernel-6.12-arm64 for arm64 architecture (minimal AMI) • al2023-ami-kernel-6.12-x86_64 for x86_64 architecture • al2023-ami-minimal-kernel-6.12-x86_64 for x86_64 architecture (minimal AMI) Please see Launching AL2023 using the SSM parameter and AWS CLI for details on selecting AL2023 AMIs. Updating an AL2023 instance to kernel 6.12 You can in-place upgrade a running AL2023 instance to kernel 6.12 with the following steps: 1. Install the kernel6.12 package: $ sudo dnf install -y kernel6.12 2. Get the latest version of the kernel6.12 package: $ version=$(rpm -q --qf '%{version}-%{release}.%{arch}\n' kernel6.12 \| sort -V \| tail -1) 3. Make
al2023-ug-107	al2023-ug.pdf	107	Kernel Updates 485 Amazon Linux 2023 User Guide • al2023-ami-minimal-kernel-6.12-arm64 for arm64 architecture (minimal AMI) • al2023-ami-kernel-6.12-x86_64 for x86_64 architecture • al2023-ami-minimal-kernel-6.12-x86_64 for x86_64 architecture (minimal AMI) Please see Launching AL2023 using the SSM parameter and AWS CLI for details on selecting AL2023 AMIs. Updating an AL2023 instance to kernel 6.12 You can in-place upgrade a running AL2023 instance to kernel 6.12 with the following steps: 1. Install the kernel6.12 package: $ sudo dnf install -y kernel6.12 2. Get the latest version of the kernel6.12 package: $ version=$(rpm -q --qf '%{version}-%{release}.%{arch}\n' kernel6.12 \| sort -V \| tail -1) 3. Make the new kernel6.12 your default kernel: $ sudo grubby --set-default "/boot/vmlinuz-$version" 4. Reboot your system: $ sudo reboot 5. (Optional) Uninstall kernel 6.1: $ sudo dnf remove -y kernel Downgrading from kernel 6.12 to kernel 6.1 If at any point in time you need to downgrade back to kernel 6.1, use the following steps: 1. Make sure to install the kernel package: $ sudo dnf install -y kernel Updating AL2023 to kernel 6.12 486 Amazon Linux 2023 User Guide 2. Get the latest version of the kernel package: $ version=$(rpm -q --qf '%{version}-%{release}.%{arch}\n' kernel \| sort -V \| tail -1) 3. Make kernel 6.1 your default kernel: $ sudo grubby --set-default "/boot/vmlinuz-$version" 4. Reboot your system: $ sudo reboot 5. (Optional) Uninstall kernel 6.12: $ sudo dnf remove -y kernel6.12 AL2023 kernels - Frequently Asked Questions 1. Do I need to reboot after a kernel update? Every change to the running kernel requires a reboot. 2. How do I keep kernels up-to-date across multiple instances? Amazon Linux does not provide facilities to manage ﬂeets of instances. We recommend you patch large ﬂeets using tools like AWS Systems Manager. 3. How do I check which kernel version I am running right now? Execute this command on your AL2023 instance: $ uname -r 4. How do I install kernel headers, development packages, and extra modules for kernel 6.12? Please run: AL2023 kernels - Frequently Asked Questions 487 Amazon Linux 2023 User Guide $ sudo dnf install -y kernel6.12-modules-extra-$(uname -r) kernel-headers-$(uname -r) kernel-devel-$(uname -r) 5. How do I select the right version of perf for my kernel? perf's features are tightly tied to the version of the kernel you are running. We provide packages perf for kernel 6.1 and perf6.12 for kernel 6.12. If you have perf installed and would like to switch to the kernel 6.12 version, please execute: $ dnf -y swap perf perf6.12 AL2023 kernels - Frequently Asked Questions 488 Amazon Linux 2023 User Guide Getting started with programming runtimes on AL2023 AL2023 provides diﬀerent versions of some language runtimes. We work with upstream projects that support multiple versions at the same time. Find information about how to install and manage these name-versioned packages using the dnf command to search and install these packages. The following topics outline how each language ecosystem exists in AL2023. Topics • C, C++, and Fortran in AL2023 • Go in AL2023 • Java in AL2023 • NodeJS in AL2023 • Perl in AL2023 • PHP in AL2023 • Python in AL2023 • Rust in AL2023 C, C++, and Fortran in AL2023 AL2023 includes both the GNU Compiler Collection (GCC) and the Clang frontend for LLVM (Low Level Virtual Machine). The major version of GCC will remain constant throughout the life time of AL2023. Minor releases bring bug ﬁxes and might be included in AL2023 releases. Other bug, performance, and security ﬁxes might be backported to the major version of GCC that ships in AL2023. AL2023 includes version 11 of GCC with the C (gcc), C++ (g++), and Fortran (gfortran) frontends. AL2023 does not enable the Ada (gnat), Go (gcc-go), Objective-C, or Objective-C++ frontends. The default compiler ﬂags that AL2023 RPMs are built with include optimization and hardening ﬂags. To build your own code with GCC, we recommend you include optimization and hardening ﬂags. C/C++ and Fortran 489 Amazon Linux 2023 Note User Guide When gcc --version is invoked, a version string such as gcc (GCC) 11.3.1 20221121 (Red Hat 11.3.1-4) is displayed. Red Hat refers to the GCC vendor branch that the Amazon Linux GCC package is based upon. According to the bug report URL shown by gcc --help, all bug reports and support requests should be directed to Amazon Linux. For more information about some of the long-term changes in this vendor branch, such as the __GNUC_RH_RELEASE__ macro, see Fedora package sources. For more information on the core toolchain, see Core toolchain packages glibc, gcc, binutils. For more information on AL2023 and its relationship to other Linux distributions, see Relationship to Fedora. For more information on the compiler triplet change in AL2023 compared to AL2, see Compiler Triplet. Go in AL2023 You might want to build your own code written in Go on
al2023-ug-108	al2023-ug.pdf	108	URL shown by gcc --help, all bug reports and support requests should be directed to Amazon Linux. For more information about some of the long-term changes in this vendor branch, such as the __GNUC_RH_RELEASE__ macro, see Fedora package sources. For more information on the core toolchain, see Core toolchain packages glibc, gcc, binutils. For more information on AL2023 and its relationship to other Linux distributions, see Relationship to Fedora. For more information on the compiler triplet change in AL2023 compared to AL2, see Compiler Triplet. Go in AL2023 You might want to build your own code written in Go on Amazon Linux, and might want to use a toolchain provided with AL2023. Similar to AL2, AL2023 will update the Go toolchain throughout the life of the operating system. This might be in response to any CVE in the toolchain we ship, or as part of a quarterly release. Go is a relatively fast moving language. There might be a situation where existing applications written in Go have to adapt to new versions of the Go toolchain. For more information about Go, see Go 1 and the Future of Go Programs. Although AL2023 will incorporate new versions of the Go toolchain during its life, this will not be in lockstep with the upstream Go releases. Therefore, using the Go toolchain provided in AL2023 might not be suitable if you want to build Go code using cutting-edge features of the Go language and standard library. During the lifetime of AL2023, previous package versions are not removed from the repositories. If a previous Go toolchain is required, you can choose to forgo the bug and security ﬁxes of newer Go toolchains and install an previous version from the repositories using the same mechanisms available for any RPM. Go 490 Amazon Linux 2023 User Guide If you want to build your own Go code on AL2023, you can use the Go toolchain included in AL2023 with the knowledge that this toolchain might move forward through the lifetime of AL2023. AL2023 Lambda functions written in Go As Go compiles to native code, Lambda treats Go as a custom runtime. You can use the provided.al2023 runtime to deploy Go functions on AL2023 to Lambda. For more information, see Building Lambda functions with Go in the AWS Lambda Developer Guide. Java in AL2023 AL2023 provides several versions of Amazon Corretto to support Java based workloads. All Java based packages included in AL2023 are built with Amazon Corretto 17 17. Corretto is a build of the Open Java Development Kit (OpenJDK) with long-term support from Amazon. Corretto is certiﬁed using the Java Technical Compatibility Kit (TCK) to ensure that it meets the Java SE standard and is available on Linux, Windows, and macOS. There is an Amazon Corretto package available for each of Corretto 1.8.0, Corretto 11, and Corretto 17. Each Corretto version in AL2023 is supported for the same period of time as the Corretto version is, or until the end of life of AL2023, whichever is sooner. For more information, see Amazon Linux package support statements and the Amazon Corretto FAQs. NodeJS in AL2023 NodeJS in AL2023 is represented by versions 18, 20 and 22. They are namespaced and can be installed simultaneously on the same system. NodeJS is distributed as several packages which include the node, the npm tool of a compatible with it version, documentation, libraries, etc. For example, for NodeJS 18, node and npm are provided by the nodejs and nodejs-npm packages. However, all following versions of NodeJS have namespaced package names which start with nodejs{MAJOR_VERSION}. For example, NodeJS 20, comes with node and npm packaged as the nodejs20 and nodejs20-npm respectively. To allow simultaneous installation of diﬀerent major versions of NodeJS, packages are shipped with executables, modules, and other ﬁles namespaced to avoid overlapping and ﬁle system AL2023 Lambda function: Go 491 Amazon Linux 2023 User Guide conﬂicts. For example, the node executable is named /usr/bin/node-{MAJOR_VERSION} and the npm executable is named /usr/bin/npm-{MAJOR_VERSION}. However, there can only be one /usr/bin/node and one /usr/bin/npm on the running system. These executables are virtual names (symlinks) and point to the actual executables of the currently active version of NodeJS. It is achieved by using alternatives system. Using alternatives allows you to use a single command to select which NodeJS version's conﬁguration ﬁles, binaries (such as node and npm), and globally installed modules are used. By default, alternatives is conﬁgured to be in auto mode, which uses priorities to select the currently active version of NodeJS. However, you can switch between installed versions at any time by running alternatives --config node. Currently, all supported NodeJS versions have equal priority. Some useful alternatives commands: 1. Check what's conﬁgured in alternatives alternatives --list 2. Check node's current conﬁguration alternatives --display node 3. Interactively change the NodeJS version alternatives
al2023-ug-109	al2023-ug.pdf	109	system. Using alternatives allows you to use a single command to select which NodeJS version's conﬁguration ﬁles, binaries (such as node and npm), and globally installed modules are used. By default, alternatives is conﬁgured to be in auto mode, which uses priorities to select the currently active version of NodeJS. However, you can switch between installed versions at any time by running alternatives --config node. Currently, all supported NodeJS versions have equal priority. Some useful alternatives commands: 1. Check what's conﬁgured in alternatives alternatives --list 2. Check node's current conﬁguration alternatives --display node 3. Interactively change the NodeJS version alternatives --config node 4. Switch to manual mode and select a speciﬁc version alternatives --set node /usr/bin/node-{MAJOR_VERSION} 5. Switch back to auto version selection mode alternatives --auto node Perl in AL2023 AL2023 provides version 5.32 of the Perl programming language. Perl 492 Amazon Linux 2023 User Guide Although Perl has provided a high degree of language compatibility as part of Perl 5 releases over the past decades, Amazon Linux is not expected to move from Perl 5.32 during the AL2023 release. Amazon Linux will continue to security patch Perl for the lifetime of AL2023 in accordance with our package support statements. Perl modules in AL2023 Various Perl modules are packaged as RPMs in AL2023. Although there are many Perl modules available as RPMs, Amazon Linux does not aim to package every possible Perl module. Modules packaged as RPMs might be relied upon by other operating system RPM packages, so Amazon Linux will prioritize those security patches over pure feature updates. AL2023 also includes CPAN so that Perl developers can use the idiomatic package manager for Perl modules. PHP in AL2023 AL2023 currently provides the PHP programming language, versions 8.1, 8.2, 8.3, and 8.4. Each version is supported for same period of time as upstream PHP. For more information, see Package support statements. Migrating from older PHP versions The upstream PHP community put together comprehensive migration documentation for moving: • from PHP 8.3.x to PHP 8.4.x • from PHP 8.2.x to PHP 8.3.x • from PHP 8.1.x to PHP 8.2.x • from PHP 8.0.x to PHP 8.1.x AL2 includes PHP 8.0, 8.1, and 8.2 in amazon-linux-extras enabling an easy upgrade path to AL2023. Perl modules 493 Amazon Linux 2023 User Guide Migrating from PHP 7.x versions Note The PHP project maintains a list and schedule of supported versions, as well as a list of unsupported branches. When AL2023 was released, all 7.x and 5.x versions of PHP were unsupported by the PHP community, and were not included as options in AL2023. The upstream PHP community put together comprehensive migration documentation for moving to PHP 8.0 from PHP 7.4. Combined with the documentation referenced in the previous section on migrating to PHP 8.1 and PHP 8.2, you can migrate your PHP based application to modern PHP. Note AL2 includes PHP 7.1, 7.2, 7.3, and 7.4 in amazon-linux-extras. It is important to note that all of these Extras are end-of-life and are not guaranteed to get any further security updates. PHP modules in AL2023 AL2023 includes many PHP modules that are included in PHP Core. AL2023 does not aim to include all of the packages in the PHP Extension Community Library (PECL). Python in AL2023 AL2023 removed Python 2.7 and any components requiring Python are now written to work with Python 3. AL2023 makes Python 3 available as /usr/bin/python3 to retain compatibility with customer code, as well as Python code shipped with AL2023, this will remain as Python 3.9 for the life of AL2023. The version of python that /usr/bin/python3 points to is considered the system Python and for AL2023 this is Python 3.9. Migrating from PHP 7.x 494 Amazon Linux 2023 User Guide Newer versions of Python, such as Python 3.11, are made available as packages in AL2023 and are supported for the lifetime of the upstream versions. For information on how long Python 3.11 is supported, see Python 3.11. Multiple versions of Python can be installed simultaneously on AL2023. Although /usr/bin/ python3 will always be Python 3.9, each version of Python is namespaced and can be found by its version number. For example, if python3.11 is installed, then /usr/bin/python3.11 will exist alongside /usr/bin/python3.9 and the /usr/bin/python3 symlink to /usr/bin/ python3.9. Note Do not change what the /usr/bin/python3 symlink points to because this might break the core functionality of AL2023. Python modules in AL2023 Various Python modules are packaged as RPMs in AL2023. Typically, RPMs for Python modules will be built targeting only the system version of Python. Rust in AL2023 You might want to build their your code written in Rust on Amazon Linux, and might want to use a toolchain provided with AL2023. Similar to AL2, AL2023 will update the Rust toolchain throughout the life of the operating system. This might
al2023-ug-110	al2023-ug.pdf	110	/usr/bin/python3.9 and the /usr/bin/python3 symlink to /usr/bin/ python3.9. Note Do not change what the /usr/bin/python3 symlink points to because this might break the core functionality of AL2023. Python modules in AL2023 Various Python modules are packaged as RPMs in AL2023. Typically, RPMs for Python modules will be built targeting only the system version of Python. Rust in AL2023 You might want to build their your code written in Rust on Amazon Linux, and might want to use a toolchain provided with AL2023. Similar to AL2, AL2023 will update the Rust toolchain throughout the life of the operating system. This might be in response to any CVE in the toolchain we ship, or as part of a quarterly release. Rust is a relatively fast moving language, with new releases on approximately a six-week cadence. These releases might add new language or standard library features. Although AL2023 will incorporate new versions of the Rust toolchain during its life, this will not be in lockstep with the upstream Rust releases. Therefore, using the Rust toolchain provided in AL2023 might not be suitable if you want to build Rust code using cutting-edge features of the Rust language. During the lifetime of AL2023, old package versions are not removed from the repositories. If an older Rust toolchain is required, you can choose to forgo bug and security ﬁxes of newer Rust toolchains and install an older version from the repositories using the same mechanisms available for any RPM. Python modules 495 Amazon Linux 2023 User Guide If you want to build your own Rust code on AL2023, you can use the Rust toolchain included in AL2023 with the knowledge that this toolchain might move forward through the lifetime of AL2023. AL2023 Lambda functions written in Rust Because Rust compiles to native code, Lambda treats Rust as a custom runtime. You can use the provided.al2023 runtime to deploy Rust functions on AL2023 to Lambda. For more information, see Building Lambda functions with Rust in the AWS Lambda Developer Guide. AL2023 Lambda function: Rust 496 Amazon Linux 2023 User Guide AL2023 Reserved Users and Groups AL2023 pre-allocates certain users and groups during both the provisioning of the image and during the installation of certain packages. The users, groups, and their associated UIDs and GIDs are listed here to prevent conﬂicts. Topics • List of AL2023 Reserved Users • List of AL2023 Reserved Groups List of AL2023 Reserved Users User name root bin daemon adm lp sync shutdown halt mail operator games ftp UID 0 1 2 3 4 5 6 7 8 11 12 14 List of AL2023 Reserved Users 497 User Guide Amazon Linux 2023 User name squid named postgres mysql nscd nscd rpcuser rpc mailnull apache smmsp tomcat ldap tss nslcd avahi tcpdump sshd radvd dbus UID 23 25 26 27 28 28 29 32 47 48 51 53 55 59 65 70 72 74 75 81 List of AL2023 Reserved Users 498 User Guide Amazon Linux 2023 User name postﬁx dovecot stapusr stapsys stapdev avahi-autoipd pulse rtkit sanlock systemd-network systemd-resolve uuidd stap-server systemd-journal-remote redis6 pesign smtpq smtpd nginx munge UID 89 97 156 157 158 170 171 172 179 192 193 961 962 963 970 971 972 973 974 975 List of AL2023 Reserved Users 499 User Guide Amazon Linux 2023 User name memcached sphinx haproxy ﬂatpak debuginfod dovenull dnsmasq unbound clamscan clamilt clamupdate colord ods aws-kinesis-agent-user saslauth cwagent polkitd ec2-instance-connect chrony systemd-timesync UID 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 List of AL2023 Reserved Users 500 User Guide Amazon Linux 2023 User name systemd-coredump libstoragemgmt systemd-oom ec2-user nobody Listed by Name User name adm apache avahi avahi-autoipd aws-kinesis-agent-user bin chrony clamilt clamscan clamupdate colord cwagent UID 996 997 999 1000 65534 UID 3 48 70 170 989 1 994 985 984 986 987 991 List of AL2023 Reserved Users 501 User Guide Amazon Linux 2023 User name daemon dbus debuginfod dnsmasq dovecot dovenull ec2-instance-connect ec2-user ﬂatpak ftp games halt haproxy ldap libstoragemgmt lp mail mailnull memcached munge UID 2 81 980 982 97 981 993 1000 979 14 12 7 978 55 997 4 8 47 976 975 List of AL2023 Reserved Users 502 User Guide Amazon Linux 2023 User name mysql named nginx nobody nscd nscd nslcd ods operator pesign polkitd postﬁx postgres pulse radvd redis6 root rpc rpcuser rtkit UID 27 25 974 65534 28 28 65 988 11 971 992 89 26 171 75 970 0 32 29 172 List of AL2023 Reserved Users 503 User Guide Amazon Linux 2023 User name sanlock saslauth shutdown smmsp smtpd smtpq sphinx squid sshd stap-server stapdev stapsys stapusr sync systemd-coredump systemd-journal-remote systemd-network systemd-oom systemd-resolve systemd-timesync UID 179 990 6 51 973 972 977 23 74 962 158 157 156 5
al2023-ug-111	al2023-ug.pdf	111	AL2023 Reserved Users 502 User Guide Amazon Linux 2023 User name mysql named nginx nobody nscd nscd nslcd ods operator pesign polkitd postﬁx postgres pulse radvd redis6 root rpc rpcuser rtkit UID 27 25 974 65534 28 28 65 988 11 971 992 89 26 171 75 970 0 32 29 172 List of AL2023 Reserved Users 503 User Guide Amazon Linux 2023 User name sanlock saslauth shutdown smmsp smtpd smtpq sphinx squid sshd stap-server stapdev stapsys stapusr sync systemd-coredump systemd-journal-remote systemd-network systemd-oom systemd-resolve systemd-timesync UID 179 990 6 51 973 972 977 23 74 962 158 157 156 5 996 963 192 999 193 995 List of AL2023 Reserved Users 504 User Guide Amazon Linux 2023 User name tcpdump tomcat tss unbound uuidd List of AL2023 Reserved Groups Group name root bin daemon sys adm tty disk disk lp mem kmem wheel UID 72 53 59 983 961 GID 0 1 2 3 4 5 6 6 7 8 9 10 List of AL2023 Reserved Groups 505 User Guide Amazon Linux 2023 Group name cdrom mail mail man dialout ﬂoppy games slocate utmp squid named postgres mysql nscd nscd rpcuser rpc tape utempter kvm GID 11 12 12 15 18 19 20 21 22 23 25 26 27 28 28 29 32 33 35 36 List of AL2023 Reserved Groups 506 User Guide Amazon Linux 2023 Group name video mailnull apache ftp smmsp tomcat lock ldap tss audio avahi tcpdump sshd radvd saslauth dbus screen wbpriv postﬁx postdrop GID 39 47 48 50 51 53 54 55 59 63 70 72 74 75 76 81 84 88 89 90 List of AL2023 Reserved Groups 507 User Guide Amazon Linux 2023 Group name dovecot users input render sgx mock stapusr stapusr stapsys stapsys stapdev stapdev avahi-autoipd pulse rtkit sanlock systemd-journal systemd-network systemd-resolve usbmon GID 97 100 104 105 106 135 156 156 157 157 158 158 170 171 172 179 190 192 193 959 List of AL2023 Reserved Groups 508 User Guide Amazon Linux 2023 Group name wireshark uuidd stap-server systemd-journal-remote usershares redis6 pesign smtpq smtpd nginx munge memcached sphinx tracing haproxy ﬂatpak debuginfod dovenull dnsmasq unbound GID 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 List of AL2023 Reserved Groups 509 User Guide Amazon Linux 2023 Group name clamscan clamilt virusgroup virusgroup virusgroup clamupdate printadmin colord ods docker aws-kinesis-agent-user cwagent pulse-rt pulse-access ec2-instance-connect chrony systemd-timesync systemd-coredump libstoragemgmt ssh_keys GID 980 981 982 982 982 983 984 985 986 987 988 989 990 991 993 994 995 996 997 998 List of AL2023 Reserved Groups 510 User Guide Amazon Linux 2023 Group name systemd-oom ec2-user ne polkitd nobody Listed by Name Group name adm apache audio avahi avahi-autoipd aws-kinesis-agent-user bin cdrom chrony clamilt clamscan clamupdate GID 999 1000 1001 9920 65534 GID 4 48 63 70 170 988 1 11 994 981 980 983 List of AL2023 Reserved Groups 511 User Guide Amazon Linux 2023 Group name colord cwagent daemon dbus debuginfod dialout disk disk dnsmasq docker dovecot dovenull ec2-instance-connect ec2-user ﬂatpak ﬂoppy ftp games haproxy input GID 985 989 2 81 976 18 6 6 978 987 97 977 993 1000 975 19 50 20 974 104 List of AL2023 Reserved Groups 512 User Guide Amazon Linux 2023 Group name kmem kvm ldap libstoragemgmt lock lp mail mail mailnull man mem memcached mock munge mysql named ne nginx nobody nscd GID 9 36 55 997 54 7 12 12 47 15 8 971 135 970 27 25 1001 969 65534 28 List of AL2023 Reserved Groups 513 User Guide Amazon Linux 2023 Group name nscd ods pesign polkitd postdrop postﬁx postgres printadmin pulse pulse-access pulse-rt radvd redis6 render root rpc rpcuser rtkit sanlock saslauth GID 28 986 966 9920 90 89 26 984 171 991 990 75 965 105 0 32 29 172 179 76 List of AL2023 Reserved Groups 514 User Guide Amazon Linux 2023 Group name screen sgx slocate smmsp smtpd smtpq sphinx squid ssh_keys sshd stap-server stapdev stapdev stapsys stapsys stapusr stapusr sys systemd-coredump systemd-journal GID 84 106 21 51 968 967 972 23 998 74 962 158 158 157 157 156 156 3 996 190 List of AL2023 Reserved Groups 515 User Guide Amazon Linux 2023 Group name systemd-journal-remote systemd-network systemd-oom systemd-resolve systemd-timesync tape tcpdump tomcat tracing tss tty unbound usbmon users usershares utempter utmp uuidd video virusgroup GID 963 192 999 193 995 33 72 53 973 59 5 979 959 100 964 35 22 961 39 982 List of AL2023 Reserved Groups 516 User Guide Amazon Linux 2023 Group name virusgroup virusgroup wbpriv wheel wireshark GID 982 982 88 10 960 List of AL2023 Reserved Groups 517 Amazon Linux 2023 User Guide List of codecs available in AL2023 AL2023 provides a
al2023-ug-112	al2023-ug.pdf	112	996 190 List of AL2023 Reserved Groups 515 User Guide Amazon Linux 2023 Group name systemd-journal-remote systemd-network systemd-oom systemd-resolve systemd-timesync tape tcpdump tomcat tracing tss tty unbound usbmon users usershares utempter utmp uuidd video virusgroup GID 963 192 999 193 995 33 72 53 973 59 5 979 959 100 964 35 22 961 39 982 List of AL2023 Reserved Groups 516 User Guide Amazon Linux 2023 Group name virusgroup virusgroup wbpriv wheel wireshark GID 982 982 88 10 960 List of AL2023 Reserved Groups 517 Amazon Linux 2023 User Guide List of codecs available in AL2023 AL2023 provides a selection of multimedia codecs through its standard repositories. This page provides an overview of the codecs and their typical use cases. Important The use and distribution of codecs included in Amazon Linux may require that you obtain license rights from third parties, including owners or licensors of certain third party audio and video formats. You are solely responsible for obtaining these licenses and paying any necessary royalties or fees. Codec ﬂac fdk-aac-free webrtc-audio-processing opus Description A free and open-source lossless audio codec that compresses audio without losing any data or quality, commonly used for high-quality audio storage An open-source implementation of the AAC (Advanced Audio Codec) standard, providing high-quality audio compression for MP3 alternatives like streaming or ﬁle storage A library for audio processing used in WebRTC (Web Real-Time Communication), oﬀering features like noise suppression, echo cancellat ion, and gain control A highly versatile and eﬃcient audio codec designed for real-time streaming, oﬀering low latency and support for a wide range of audio applications, including VoIP and music streaming 518 Amazon Linux 2023 Codec libsndﬁle User Guide Description A library for reading and writing audio ﬁles in various formats (such as WAV, AIFF, and FLAC), commonly used in audio processing and manipulation tools 519 Amazon Linux 2023 User Guide Security and Compliance in Amazon Linux 2023 Important If you want to report a vulnerability or have a security concern regarding AWS cloud services or open source projects, contact AWS Security using the Vulnerability Reporting page Cloud security at AWS is the highest priority. As an AWS customer, you beneﬁt 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 eﬀectiveness of our security as part of the AWS Compliance Programs. To learn about the compliance programs that apply to AL2023, 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. Topics • Amazon Linux Security advisories for AL2023 • Listing applicable Advisories • Applying security updates in-place • Setting SELinux modes for AL2023 • Enable FIPS Mode on AL2023 • Enable FIPS Mode in an AL2023 Container • Swap OpenSSL FIPS providers on AL2023 • AL2023 Kernel Hardening 520 Amazon Linux 2023 • UEFI Secure Boot on AL2023 User Guide Amazon Linux Security advisories for AL2023 Although we work hard to make Amazon Linux secure, at times there will be security issues that require ﬁxing. An advisory is issued when a ﬁx is available. The primary location where we publish advisories is the Amazon Linux Security Center (ALAS). For more information, see Amazon Linux Security Center. Important If you want to report a vulnerability or have a security concern regarding AWS cloud services or open source projects, contact AWS Security using the Vulnerability Reporting page Information on issues and the relevant updates that aﬀect AL2023 are published by the Amazon Linux team in several locations. It's common for security tooling to fetch information from these primary sources and present the results to you. As such, you might not directly interact with the primary sources that Amazon Linux publishes, but instead the interface provided by your preferred tooling, such as Amazon Inspector. Amazon Linux Security Center announcements Amazon Linux announcements are provided for items that do not ﬁt into an advisory. This section contains announcements about ALAS itself, along with information that does not ﬁt in an advisory. For more information, see Amazon Linux Security Center (ALAS) Announcements. For example, the 2021-001 - Amazon Linux Hotpatch Announcement for Apache Log4j ﬁt into an announcement rather than an advisory. In this announcement, Amazon Linux added a package to help customers mitigate a
al2023-ug-113	al2023-ug.pdf	113	with the primary sources that Amazon Linux publishes, but instead the interface provided by your preferred tooling, such as Amazon Inspector. Amazon Linux Security Center announcements Amazon Linux announcements are provided for items that do not ﬁt into an advisory. This section contains announcements about ALAS itself, along with information that does not ﬁt in an advisory. For more information, see Amazon Linux Security Center (ALAS) Announcements. For example, the 2021-001 - Amazon Linux Hotpatch Announcement for Apache Log4j ﬁt into an announcement rather than an advisory. In this announcement, Amazon Linux added a package to help customers mitigate a security issue in software that was not part of Amazon Linux. The Amazon Linux Security Center CVE Explorer was also announced on ALAS announcements. For more information, see New website for CVEs. Amazon Linux Security Center Frequently Asked Questions For answers to some frequently asked questions about ALAS and how Amazon Linux evaluates CVEs, see Amazon Linux Security Center (ALAS) Frequently Asked Questions (FAQs). Security advisories 521 Amazon Linux 2023 ALAS Advisories User Guide An Amazon Linux Advisory contains important information relevant to Amazon Linux users, typically information about security updates. The Amazon Linux Security Center is where Advisories are visible on the web. Advisory information is also part of the RPM package repository metadata. Advisories and RPM repositories An Amazon Linux 2023 package repository may contain metadata describing zero or more updates. The dnf updateinfo command is named after the repository metadata ﬁlename which contains this information, updateinfo.xml. While the command is named updateinfo, and the metadata ﬁle refers to an update, these all refer to package updates which are part of an Advisory. Amazon Linux Advisories are published on the Amazon Linux Security Center web site, along with information being present in the RPM repository metadata that the dnf package manager refers to. The web site and repository metadata are eventually consistent, and there may be inconsistencies in the information on the web site and in repository metadata. This will typically occur when a new release of AL2023 is in the process of being released, there has been an update to an Advisory after the most recent AL2023 release. While it is typical for a new Advisory to be issued alongside the package update which addresses the issue, this is not always the case. An Advisory can be created for a new issue which is addressed in already released packages. An existing Advisory may also be updated with new CVEs which are addressed by the existing update. The Deterministic upgrades through versioned repositories on AL2023 feature of Amazon Linux 2023 means that the RPM repository for a particular AL2023 version contains a snapshot of the RPM repository metadata as of that version. This includes the metadata describing security updates. The RPM repository for particular AL2023 version is not updated after release. New or updated security advisories will not be visible when looking at an older version of the AL2023 RPM repositories. Refer to the Listing applicable Advisories section for how to use the dnf package manager to look at either the latest repository version, or a speciﬁc AL2023 release. Advisory IDs Each Advisory is referred to by an id. It is currently a quirk of Amazon Linux where the Amazon Linux Security Center web site will list an Advisory as ALAS-2024-581, while the dnf package manager will list that advisory as having the ID of ALAS2023-2024-581. When Applying security updates in-place the package manager ID needs to be used if referring to a speciﬁc Advisory. ALAS Advisories 522 Amazon Linux 2023 User Guide For Amazon Linux, each major version of the OS has its own namespace of Advisory IDs. There should be no assumptions made as to the format of Amazon Linux Advisory IDs. Historically, Amazon Linux Advisory IDs have followed the pattern of NAMESPACE-YEAR-NUMBER. The full range of possible values for NAMESPACE is not deﬁned, but has included ALAS, ALASCORRETTO8, ALAS2023, ALAS2, ALASPYTHON3.8, and ALASUNBOUND-1.17. The YEAR has been the year in which the advisory was created, and NUMBER being a unique integer within the namespace. While Advisory IDs will typically be sequential and in the order the updates are released, there are many reasons why this could not be the case, so this should not be assumed. Treat the Advisory ID as an opaque string which is unique to each major version of Amazon Linux. In Amazon Linux 2, each Extra was in a separate RPM repository, and the Advisory metadata is contained only within the repository to which it is relevant. An Advisory for one repository is not applicable to another repository. On the Amazon Linux Security Center web site, there is currently one list of Advisories for each major Amazon Linux version, and it is not separated out into per- repository lists. As AL2023
al2023-ug-114	al2023-ug.pdf	114	could not be the case, so this should not be assumed. Treat the Advisory ID as an opaque string which is unique to each major version of Amazon Linux. In Amazon Linux 2, each Extra was in a separate RPM repository, and the Advisory metadata is contained only within the repository to which it is relevant. An Advisory for one repository is not applicable to another repository. On the Amazon Linux Security Center web site, there is currently one list of Advisories for each major Amazon Linux version, and it is not separated out into per- repository lists. As AL2023 does not use the Extras mechanism to package alternate versions of packages, there are currently only two RPM repositories, each of which has Advisories, the core repository and the livepatch repository. The livepatch repository is for Kernel Live Patching on AL2023. Advisory Creation and Update timestamps The creation timestamp for Amazon Linux Advisories will typically be close to when the Advisory was published, but this is not universally the case. The update timestamp is similar, and the package repositories and Amazon Linux Security Center web site may not be updated in sync as new information is available. A (relatively) common case where Advisory timestamps may not exactly match when the Advisory is issued is where there was a longer gap between the Advisories and RPM repository content being prepared and when they were made live. There should not be any assumptions made between the AL2023 version number (e.g. 2023.6.20241031) and the creation/update timestamps of Advisories published alongside that release. Advisory Creation and Update timestamps 523 Amazon Linux 2023 Advisory Types User Guide The RPM repository metadata supports Advisories of diﬀerent types. While Amazon Linux has near universally only issued Advisories which are security updates, this should not be assumed. It is possible that Advisories for events such as bug ﬁxes, enhancements, and new packages could be issued, and the Advisory be marked as containing that type of update. Advisory Severities Each Advisory has its own Severity as each issue is evaluated separately. Multiple CVEs may be addressed in a single Advisory, and each CVE may have a diﬀerent evaluation, but the Advisory itself has one Severity. There can be multiple Advisories referring to a single package update, thus there can be multiple Severities for a particular package update (one per Advisory). In order of decreasing Severity, Amazon Linux has used Critical, Important, Moderate, and Low to indicate the Severity of an Advisory. Amazon Linux Advisories may also not have a Severity, although this is exceedingly rare. Amazon Linux is one of the RPM based Linux distributions that uses the term Moderate, while some other RPM based Linux distributions use the equivalent term Medium. The Amazon Linux package manager treats both terms as equivalent, and third party package repositories may use the term Medium. Amazon Linux Advisories can change Severity over time as more is learned about the relevant issues addressed in the Advisory. The Severity of an Advisory will typically track the highest Amazon Linux evaluated CVSS score for the CVEs referenced by the Advisory. There may be cases where this is not the case. One example would be where there is an issue which is addressed for which there is not a CVE assigned. See the ALAS FAQ for more information about how Amazon Linux uses Advisory severity ratings. Advisories and Packages There can be many Advisories for a single package, and not all packages will ever have an Advisory published for them. A particular package version can be referenced in multiple Advisories, each with its own Severity and CVEs. It is possible for multiple Advisories for the same package update to be issued simultaneously in one new AL2023 release, or in rapid succession. Advisory Types 524 Amazon Linux 2023 User Guide Like other Linux distributions, there can be one to many diﬀerent binary packages built from the same source package. For example, ALAS-2024-698 is an Advisory listed on the AL2023 section of the Amazon Linux Security Center web site as applying to the mariadb105 package. This is the source package name, and the Advisory itself refers to the binary packages alongside the source package. In this case, over a dozen binary packages are built from the one mariadb105 source package. While it is extremely common for there to be a binary package with the same name as the source package, this is not universal. While Amazon Linux Advisories have typically listed all binary packages built from the updated source package, this should not be assumed. The package manager and RPM repository metadata format allows for Advisories that list a subset of the updated binary packages. A particular Advisory may also only apply to a particular CPU Architecture. There can be packages that are not built for all architectures,
al2023-ug-115	al2023-ug.pdf	115	a dozen binary packages are built from the one mariadb105 source package. While it is extremely common for there to be a binary package with the same name as the source package, this is not universal. While Amazon Linux Advisories have typically listed all binary packages built from the updated source package, this should not be assumed. The package manager and RPM repository metadata format allows for Advisories that list a subset of the updated binary packages. A particular Advisory may also only apply to a particular CPU Architecture. There can be packages that are not built for all architectures, or issues that do not aﬀect all architectures. In the case where a package is available on all architectures but an issue applies only to one, Amazon Linux has typically not issued an Advisory only referencing only the aﬀected architecture, although this should not be assumed. Due to the nature of package dependencies, it is common that an Advisory references one package, but installing that update will require other package updates, including packages that are not listed in the Advisory. The dnf package manager will handle installing the required dependencies. Advisories and CVEs An Advisory may address zero or more CVEs, and there may be multiple Advisories referencing the same CVE. An example of when an Advisory may reference zero CVEs is when a CVE is not yet (or ever) assigned to the issue. An example of where multiple Advisories may reference the same CVE when (for example) the CVE is applicable to multiple packages. For example, CVE-2024-21208 applies to Corretto 8, 11, 17, and 21. Each of these Corretto versions is a separate package in AL2023, and there is an Advisory for each of these packages: ALAS-2024-754 for Corretto 8, ALAS-2024-753 for Corretto 11, ALAS-2024-752 for Corretto 17, and ALAS-2024-752 for Corretto 21. While these Corretto releases all have the same list of CVEs, this should not be assumed. A particular CVE can be evaluated diﬀerently for diﬀerent packages. For example, if a particular CVE is referenced in an Advisory with a Severity of Important, it is possible that another Advisory is issued referencing the same CVE with a diﬀerent Severity. Advisories and CVEs 525 Amazon Linux 2023 User Guide The RPM repository metadata allows for a list of References for each Advisory. While Amazon Linux has typically only referenced CVEs, the metadata format does allow for other reference types. The RPM package repository metadata will only refer to CVEs with a ﬁx available. The Explore section of the Amazon Linux Security Center web site contains information on CVEs that Amazon Linux has evaluated. This evaluation may result in a CVSS base score, Severity, and status for various Amazon Linux releases and packages. The status for a CVE for a particular Amazon Linux release or package may be Not Aﬀected, Pending Fix, or No Fix Planned. The status and evaluation of CVEs may change many times and in any way prior to an Advisory being issued. This includes re- evaluation of the applicability of a CVE to Amazon Linux. The list of CVEs referenced by an Advisory can change after initial publication of that Advisory. Advisory Text An Advisory will also contain text describing the issue or issues that were the reason for creating the Advisory. It is common that this text will be the unmodiﬁed CVE text. This text may refer to upstream version numbers where a ﬁx is available which are diﬀerent from the package version that Amazon Linux has applied a ﬁx to. It is common that Amazon Linux will back-port ﬁxes from newer upstream releases. In the case where the Advisory text mentions an upstream release which is diﬀerent than the version shipped in an Amazon Linux version, the Amazon Linux package versions in the Advisory will be accurate for Amazon Linux. It is possible for the Advisory text in the RPM repository metadata to be placeholder text simply referring to the Amazon Linux Security Center web site for details. Kernel Live Patch Advisories Advisories for live patches are unique in that they refer to a diﬀerent package (the Linux kernel) than the package the Advisory is against (e.g. kernel-livepatch-6.1.15-28.43). An Advisory for a Kernel Live Patch will reference the issues (such as CVEs) which the particular Live Patch package can address for the speciﬁc kernel version to which the live patch package applies. Each live patch is for a speciﬁc kernel version. In order to apply a live patch for a CVE, the right live patch package for your kernel version needs to be installed, and the live patch applied. For example, CVE-2023-6111 can be live patched for AL2023 kernel versions 6.1.56-82.125, 6.1.59-84.139, and 6.1.61-85.141. A new kernel version with a ﬁx for this CVE was also released, and has a separate advisory. In
al2023-ug-116	al2023-ug.pdf	116	Live Patch will reference the issues (such as CVEs) which the particular Live Patch package can address for the speciﬁc kernel version to which the live patch package applies. Each live patch is for a speciﬁc kernel version. In order to apply a live patch for a CVE, the right live patch package for your kernel version needs to be installed, and the live patch applied. For example, CVE-2023-6111 can be live patched for AL2023 kernel versions 6.1.56-82.125, 6.1.59-84.139, and 6.1.61-85.141. A new kernel version with a ﬁx for this CVE was also released, and has a separate advisory. In order for CVE-2023-6111 to be addressed on AL2023 Advisory Text 526 Amazon Linux 2023 User Guide either a kernel version equal to or later than what ALAS2023-2023-461 speciﬁes needs to be running, or one of the kernel versions with a live patch for this CVE needs to be running with the applicable livepatch applied. When there are new live patches available for a speciﬁc kernel version which already has a live patch available, a new version of the kernel-livepatch-KERNEL_VERSION package is released. For example, the ALASLIVEPATCH-2023-003 Advisory was issued with the kernel- livepatch-6.1.15-28.43-1.0-1.amzn2023 package which contained live patches for the 6.1.15-28.43 kernel covering three CVEs. Later, the ALASLIVEPATCH-2023-009 Advisory was issued with the kernel-livepatch-6.1.15-28.43-1.0-2.amzn2023 package; an update to the previous live patch package for the 6.1.15-28.43 kernel containing live patches for another three CVEs. There were also other live patch Advisories issues for other kernel versions, with packages containing live patches for those speciﬁc kernel versions. For more information on kernel live patching, see Kernel Live Patching on AL2023. For anyone developing tools around security advisories, it is also recommended to look at the XML Schema for Advisories and updateinfo.xml section for more information. XML Schema for Advisories and updateinfo.xml The updateinfo.xml ﬁle is part of the package repository format. It is the metadata that the dnf package manager parses to implement functionality such as Listing applicable Advisories and Applying security updates in-place. We recommended that the API of the dnf package manager is used rather than writing custom code to parse the repository metadata formats. The version of dnf in AL2023 can parse both the AL2023 and AL2 repository formats, and thus the API can be used to examine advisory information for either OS version. The RPM Software Management project documents the RPM metadata formats in the rpm- metadata repository on GitHub. For those developing tools to directly parse the updateinfo.xml metadata, paying careful attention to the rpm-metadata documentation is strongly advised. The documentation covers what has been seen in the wild, which includes many exceptions to what you may reasonably interpret as a rule for the metadata format. There is also a growing set of real-world examples of updateinfo.xml ﬁles in the raw-historical- rpm-repository-examples repository on GitHub. updateinfo.xml schema 527 Amazon Linux 2023 User Guide In case anything is unclear in the documentation, you can open an issue on the GitHub project so that we can answer the question and update the documentation appropriately. As Open Source projects, pull requests updating documentation are also welcome. Listing applicable Advisories The dnf package manager has access to metadata describing what Advisories are ﬁxed in what package versions. It can thus list what Advisories are applicable to an instance or container image. Note Tools such as AWS Systems Manager can use this functionality to show what updates are relevant across a ﬂeet rather than just a single instance. When listing updates, you can instruct dnf to look at the metadata of a particular AL2023 release, or the metadata from the latest release. Note Once an AL2023 release is made, it is immutable. Thus, new or updated advisories on the Amazon Linux Security Center are only added to the metadata of new releases of AL2023 We will now go through examples of looking at what advisories apply to some AL2023 container images. These commands all work on non-containerized environments such as EC2 instances. Listing advisories in a speciﬁc version In this example we are going to look at what advisories in the 2023.1.20230628 release are relevant in a container image of the 2023.0.20230315 release. Note This example uses the 2023.0.20230315 and 2023.1.20230628 releases, and these are not the latest release of AL2023 See the AL2023 Release Notes for the latest releases, which contain the latest security updates. Listing applicable Advisories 528 Amazon Linux 2023 User Guide In this example we will be starting with a container image for the 2023.0.20230315 release. First, we fetch this container image from the container registry. The .0 at the end indicates the version of the image for a particular release; this image version is usually zero. $ docker pull public.ecr.aws/amazonlinux/amazonlinux:2023.0.20230315.0 2023.0.20230315.0: Pulling from amazonlinux/amazonlinux b76f3b09316a: Pull complete Digest: sha256:94e7183b0739140dbd5b639fb7600f0a2299cec5df8780c26d9cb409da5315a9 Status: Downloaded newer image for public.ecr.aws/amazonlinux/ amazonlinux:2023.0.20230315.0
al2023-ug-117	al2023-ug.pdf	117	releases, and these are not the latest release of AL2023 See the AL2023 Release Notes for the latest releases, which contain the latest security updates. Listing applicable Advisories 528 Amazon Linux 2023 User Guide In this example we will be starting with a container image for the 2023.0.20230315 release. First, we fetch this container image from the container registry. The .0 at the end indicates the version of the image for a particular release; this image version is usually zero. $ docker pull public.ecr.aws/amazonlinux/amazonlinux:2023.0.20230315.0 2023.0.20230315.0: Pulling from amazonlinux/amazonlinux b76f3b09316a: Pull complete Digest: sha256:94e7183b0739140dbd5b639fb7600f0a2299cec5df8780c26d9cb409da5315a9 Status: Downloaded newer image for public.ecr.aws/amazonlinux/ amazonlinux:2023.0.20230315.0 public.ecr.aws/amazonlinux/amazonlinux:2023.0.20230315.0 We can now spawn a shell inside the container, from which we will ask dnf to list what advisories are relevant to the packages installed in the container. $ docker run -it public.ecr.aws/amazonlinux/amazonlinux:2023.0.20230315.0 bash-5.2# The dnf updateinfo command is now used to display a summary of what advisories in the 2023.1.20230628 release are relevant to our installed packages. $ dnf updateinfo --releasever=2023.1.20230628 Amazon Linux 2023 repository 42 MB/s \| 15 MB 00:00 Last metadata expiration check: 0:00:02 ago on Mon Jul 22 20:24:24 2024. Updates Information Summary: available 8 Security notice(s) 1 Important Security notice(s) 5 Medium Security notice(s) 2 Low Security notice(s) To get a list of the advisories, the --list option can be given to dnf updateinfo. $ dnf updateinfo --releasever=2023.1.20230628 --list Last metadata expiration check: 0:01:22 ago on Mon Jul 22 20:24:24 2024. ALAS2023-2023-193 Medium/Sec. curl-minimal-8.0.1-1.amzn2023.x86_64 ALAS2023-2023-225 Medium/Sec. glib2-2.74.7-688.amzn2023.0.1.x86_64 ALAS2023-2023-195 Low/Sec. libcap-2.48-2.amzn2023.0.3.x86_64 ALAS2023-2023-193 Medium/Sec. libcurl-minimal-8.0.1-1.amzn2023.x86_64 ALAS2023-2023-145 Low/Sec. libgcc-11.3.1-4.amzn2023.0.3.x86_64 ALAS2023-2023-145 Low/Sec. libgomp-11.3.1-4.amzn2023.0.3.x86_64 Listing applicable Advisories 529 Amazon Linux 2023 User Guide ALAS2023-2023-145 Low/Sec. libstdc++-11.3.1-4.amzn2023.0.3.x86_64 ALAS2023-2023-163 Medium/Sec. libxml2-2.10.4-1.amzn2023.0.1.x86_64 ALAS2023-2023-220 Important/Sec. ncurses-base-6.2-4.20200222.amzn2023.0.4.noarch ALAS2023-2023-220 Important/Sec. ncurses-libs-6.2-4.20200222.amzn2023.0.4.x86_64 ALAS2023-2023-181 Medium/Sec. openssl-libs-1:3.0.8-1.amzn2023.0.2.x86_64 ALAS2023-2023-222 Medium/Sec. openssl-libs-1:3.0.8-1.amzn2023.0.3.x86_64 Listing advisories in the latest version In this example we are going to look at what updates are available in the latest version of AL2023 if we launched a container of the 2023.4.20240319 release. At the time of writing, the latest release is 2023.5.20240708, so the listed updates in this example will be as of that release. Note This example uses the 2023.4.20240319 and 2023.5.20240708 releases, the latter being the latest release at the time of writing. For more information on the latest releases, see the AL2023 Release Notes. In this example we will be starting with a container image for the 2023.4.20240319 release. First, we fetch this container image from the container registry. The .1 at the end indicates the version of the image for a particular release. While the image version is typically zero, this example uses a release where the image version is one. $ docker pull public.ecr.aws/amazonlinux/amazonlinux:2023.4.20240319.1 2023.4.20240319.1: Pulling from amazonlinux/amazonlinux 6de065fda9a2: Pull complete Digest: sha256:b4838c4cc9211d966b6ea158dacc9eda7433a16ba94436508c2d9f01f7658b4e Status: Downloaded newer image for public.ecr.aws/amazonlinux/ amazonlinux:2023.4.20240319.1 public.ecr.aws/amazonlinux/amazonlinux:2023.4.20240319.1 We can now spawn a shell inside the container, from which we will check for updates. $ docker run -it public.ecr.aws/amazonlinux/amazonlinux:2023.4.20240319.1 bash-5.2# Listing applicable Advisories 530 Amazon Linux 2023 User Guide The dnf updateinfo command is now used to display a summary of what advisories in the latest release are relevant to our installed packages. At the time of writing, 2023.1.20230628 was the latest release. $ dnf --releasever=latest updateinfo Amazon Linux 2023 repository 76 MB/s \| 25 MB 00:00 Last metadata expiration check: 0:00:04 ago on Mon Jul 22 20:59:54 2024. Updates Information Summary: available 9 Security notice(s) 4 Important Security notice(s) 4 Medium Security notice(s) 1 Low Security notice(s) To get a list of the advisories, the --list option can be given to dnf updateinfo. $ dnf updateinfo --releasever=latest --list Last metadata expiration check: 0:00:58 ago on Mon Jul 22 20:59:54 2024. ALAS2023-2024-581 Low/Sec. curl-minimal-8.5.0-1.amzn2023.0.3.x86_64 ALAS2023-2024-596 Medium/Sec. curl-minimal-8.5.0-1.amzn2023.0.4.x86_64 ALAS2023-2024-576 Important/Sec. expat-2.5.0-1.amzn2023.0.4.x86_64 ALAS2023-2024-589 Important/Sec. glibc-2.34-52.amzn2023.0.10.x86_64 ALAS2023-2024-589 Important/Sec. glibc-common-2.34-52.amzn2023.0.10.x86_64 ALAS2023-2024-589 Important/Sec. glibc-minimal-langpack-2.34-52.amzn2023.0.10.x86_64 ALAS2023-2024-586 Medium/Sec. krb5-libs-1.21-3.amzn2023.0.4.x86_64 ALAS2023-2024-581 Low/Sec. libcurl-minimal-8.5.0-1.amzn2023.0.3.x86_64 ALAS2023-2024-596 Medium/Sec. libcurl-minimal-8.5.0-1.amzn2023.0.4.x86_64 ALAS2023-2024-592 Important/Sec. libnghttp2-1.59.0-3.amzn2023.0.1.x86_64 ALAS2023-2024-640 Medium/Sec. openssl-libs-1:3.0.8-1.amzn2023.0.12.x86_64 ALAS2023-2024-605 Medium/Sec. python3-3.9.16-1.amzn2023.0.7.x86_64 ALAS2023-2024-616 Important/Sec. python3-3.9.16-1.amzn2023.0.8.x86_64 ALAS2023-2024-605 Medium/Sec. python3-libs-3.9.16-1.amzn2023.0.7.x86_64 ALAS2023-2024-616 Important/Sec. python3-libs-3.9.16-1.amzn2023.0.8.x86_64 Applying security updates in-place For an overview of applying updates, see Applying security updates using DNF and repository versions. The --security option to dnf upgrade will restrict package updates to only those which have an Advisory. The remainder of this section will cover how to install only speciﬁc security updates. In-place updates 531 Amazon Linux 2023 Note User Guide It is recommended to apply all updates available in a new AL2023 release. Picking just security updates, or only speciﬁc updates should be the exception rather than rule. Applying updates mentioned in an Advisory The advisory identiﬁers in the ﬁrst column of the output of dnf upgradeinfo can be used to apply updates for the packages mentioned in the advisory. The dnf package manager can be instructed to update the packages in the advisory to either the latest available, or only up to the versions mentioned in the advisory. If the updates are already installed, the update command is a no-op. To apply
al2023-ug-118	al2023-ug.pdf	118	to apply all updates available in a new AL2023 release. Picking just security updates, or only speciﬁc updates should be the exception rather than rule. Applying updates mentioned in an Advisory The advisory identiﬁers in the ﬁrst column of the output of dnf upgradeinfo can be used to apply updates for the packages mentioned in the advisory. The dnf package manager can be instructed to update the packages in the advisory to either the latest available, or only up to the versions mentioned in the advisory. If the updates are already installed, the update command is a no-op. To apply the updates for aﬀected packages only up to the version mention in the advisory, use the dnf upgrade-minimal command while using the --advisory option to specify the advisory. The following example is running dnf upgrade-minimal in an AL2023 version 2023.0.20230315 container. $ dnf upgrade-minimal -y --releasever=2023.1.20230628 --advisory ALAS2023-2023-193 Amazon Linux 2023 repository 46 MB/s \| 15 MB 00:00 Last metadata expiration check: 0:00:03 ago on Mon Jul 22 20:36:13 2024. Dependencies resolved. ================================================================================ Package Arch Version Repository Size ================================================================================ Upgrading: curl-minimal x86_64 8.0.1-1.amzn2023 amazonlinux 150 k libcurl-minimal x86_64 8.0.1-1.amzn2023 amazonlinux 249 k Transaction Summary ================================================================================ Upgrade 2 Packages Total download size: 399 k Downloading Packages: (1/2): curl-minimal-8.0.1-1.amzn2023.x86_64.rpm 2.7 MB/s \| 150 kB 00:00 (2/2): libcurl-minimal-8.0.1-1.amzn2023.x86_64. 3.8 MB/s \| 249 kB 00:00 -------------------------------------------------------------------------------- Total 2.5 MB/s \| 399 kB 00:00 Running transaction check Applying updates mentioned in an Advisory 532 Amazon Linux 2023 User Guide Transaction check succeeded. Running transaction test Transaction test succeeded. Running transaction Preparing : 1/1 Upgrading : libcurl-minimal-8.0.1-1.amzn2023.x86_64 1/4 Upgrading : curl-minimal-8.0.1-1.amzn2023.x86_64 2/4 Cleanup : curl-minimal-7.88.1-1.amzn2023.0.1.x86_64 3/4 Cleanup : libcurl-minimal-7.88.1-1.amzn2023.0.1.x86_64 4/4 Running scriptlet: libcurl-minimal-7.88.1-1.amzn2023.0.1.x86_64 4/4 Verifying : libcurl-minimal-8.0.1-1.amzn2023.x86_64 1/4 Verifying : libcurl-minimal-7.88.1-1.amzn2023.0.1.x86_64 2/4 Verifying : curl-minimal-8.0.1-1.amzn2023.x86_64 3/4 Verifying : curl-minimal-7.88.1-1.amzn2023.0.1.x86_64 4/4 Upgraded: curl-minimal-8.0.1-1.amzn2023.x86_64 libcurl-minimal-8.0.1-1.amzn2023.x86_64 Complete! The same package versions are updated even if --releasever=latest is used as the request is for dnf to do the minimal update required to address the advisory. Using the regular dnf upgrade command with the --advisory option will update the relevant packages mentioned in the advisory to the latest version available, which may be newer than the version mentioned in the advisory. Note Unless the system-release package is updated, the version of the AL2023 repositories which dnf is locked to does not change. Warning When installing updates from a diﬀerent release of AL2023 without changing the version of the repository that dnf is locked to, care must be taken on any subsequent mutating dnf operations. For example, when installing or updating packages, since package dependencies may have changed in the newer release, the older release that you remain on may not be able to satisfy these new dependencies. Applying updates mentioned in an Advisory 533 Amazon Linux 2023 User Guide The following example is run in an AL2023 version 2023.0.20230315 container referring to the latest release of AL2023 which the time of writing was 2023.5.20240708. Note that both the version of curl being updated to is newer than the version update-minimal updated to, but that this newer version brings in new dependencies. $ dnf upgrade -y --releasever=latest --advisory ALAS2023-2023-193 Amazon Linux 2023 repository 80 MB/s \| 25 MB 00:00 Last metadata expiration check: 0:00:04 ago on Mon Jul 22 20:48:38 2024. Dependencies resolved. ================================================================================ Package Arch Version Repository Size ================================================================================ Upgrading: curl-minimal x86_64 8.5.0-1.amzn2023.0.4 amazonlinux 160 k libcurl-minimal x86_64 8.5.0-1.amzn2023.0.4 amazonlinux 275 k libnghttp2 x86_64 1.59.0-3.amzn2023.0.1 amazonlinux 79 k Installing dependencies: libpsl x86_64 0.21.1-3.amzn2023.0.2 amazonlinux 61 k publicsuffix-list-dafsa noarch 20240212-61.amzn2023 amazonlinux 59 k Transaction Summary ================================================================================ Install 2 Packages Upgrade 3 Packages Total download size: 634 k Downloading Packages: (1/5): publicsuffix-list-dafsa-20240212-61.amzn 1.1 MB/s \| 59 kB 00:00 (2/5): curl-minimal-8.5.0-1.amzn2023.0.4.x86_64 2.6 MB/s \| 160 kB 00:00 (3/5): libpsl-0.21.1-3.amzn2023.0.2.x86_64.rpm 949 kB/s \| 61 kB 00:00 (4/5): libnghttp2-1.59.0-3.amzn2023.0.1.x86_64. 3.7 MB/s \| 79 kB 00:00 (5/5): libcurl-minimal-8.5.0-1.amzn2023.0.4.x86 6.7 MB/s \| 275 kB 00:00 -------------------------------------------------------------------------------- Total 3.5 MB/s \| 634 kB 00:00 Running transaction check Transaction check succeeded. Running transaction test Transaction test succeeded. Running transaction Preparing : 1/1 Upgrading : libnghttp2-1.59.0-3.amzn2023.0.1.x86_64 1/8 Installing : publicsuffix-list-dafsa-20240212-61.amzn2023.noarch 2/8 Installing : libpsl-0.21.1-3.amzn2023.0.2.x86_64 3/8 Applying updates mentioned in an Advisory 534 Amazon Linux 2023 User Guide Upgrading : libcurl-minimal-8.5.0-1.amzn2023.0.4.x86_64 4/8 Upgrading : curl-minimal-8.5.0-1.amzn2023.0.4.x86_64 5/8 Cleanup : curl-minimal-7.88.1-1.amzn2023.0.1.x86_64 6/8 Cleanup : libcurl-minimal-7.88.1-1.amzn2023.0.1.x86_64 7/8 Cleanup : libnghttp2-1.51.0-1.amzn2023.x86_64 8/8 Running scriptlet: libnghttp2-1.51.0-1.amzn2023.x86_64 8/8 Verifying : libpsl-0.21.1-3.amzn2023.0.2.x86_64 1/8 Verifying : publicsuffix-list-dafsa-20240212-61.amzn2023.noarch 2/8 Verifying : curl-minimal-8.5.0-1.amzn2023.0.4.x86_64 3/8 Verifying : curl-minimal-7.88.1-1.amzn2023.0.1.x86_64 4/8 Verifying : libcurl-minimal-8.5.0-1.amzn2023.0.4.x86_64 5/8 Verifying : libcurl-minimal-7.88.1-1.amzn2023.0.1.x86_64 6/8 Verifying : libnghttp2-1.59.0-3.amzn2023.0.1.x86_64 7/8 Verifying : libnghttp2-1.51.0-1.amzn2023.x86_64 8/8 Upgraded: curl-minimal-8.5.0-1.amzn2023.0.4.x86_64 libcurl-minimal-8.5.0-1.amzn2023.0.4.x86_64 libnghttp2-1.59.0-3.amzn2023.0.1.x86_64 Installed: libpsl-0.21.1-3.amzn2023.0.2.x86_64 publicsuffix-list-dafsa-20240212-61.amzn2023.noarch Complete! Setting SELinux modes for AL2023 By default, Security Enhanced Linux (SELinux) is enabled and set to permissive mode for AL2023. In permissive mode, permission denials are logged but not enforced. SELinux is a collection of kernel features and utilities to provide a strong, ﬂexible, mandatory access control (MAC) architecture to
al2023-ug-119	al2023-ug.pdf	119	libcurl-minimal-7.88.1-1.amzn2023.0.1.x86_64 7/8 Cleanup : libnghttp2-1.51.0-1.amzn2023.x86_64 8/8 Running scriptlet: libnghttp2-1.51.0-1.amzn2023.x86_64 8/8 Verifying : libpsl-0.21.1-3.amzn2023.0.2.x86_64 1/8 Verifying : publicsuffix-list-dafsa-20240212-61.amzn2023.noarch 2/8 Verifying : curl-minimal-8.5.0-1.amzn2023.0.4.x86_64 3/8 Verifying : curl-minimal-7.88.1-1.amzn2023.0.1.x86_64 4/8 Verifying : libcurl-minimal-8.5.0-1.amzn2023.0.4.x86_64 5/8 Verifying : libcurl-minimal-7.88.1-1.amzn2023.0.1.x86_64 6/8 Verifying : libnghttp2-1.59.0-3.amzn2023.0.1.x86_64 7/8 Verifying : libnghttp2-1.51.0-1.amzn2023.x86_64 8/8 Upgraded: curl-minimal-8.5.0-1.amzn2023.0.4.x86_64 libcurl-minimal-8.5.0-1.amzn2023.0.4.x86_64 libnghttp2-1.59.0-3.amzn2023.0.1.x86_64 Installed: libpsl-0.21.1-3.amzn2023.0.2.x86_64 publicsuffix-list-dafsa-20240212-61.amzn2023.noarch Complete! Setting SELinux modes for AL2023 By default, Security Enhanced Linux (SELinux) is enabled and set to permissive mode for AL2023. In permissive mode, permission denials are logged but not enforced. SELinux is a collection of kernel features and utilities to provide a strong, ﬂexible, mandatory access control (MAC) architecture to the major subsystems of the kernel. SELinux provides an enhanced mechanism to enforce the separation of information based on conﬁdentiality and integrity requirements. This separation of information reduces threats of tampering and bypassing of application security mechanisms. It also conﬁnes damage that can be caused by malicious or ﬂawed applications. SELinux includes a set of sample security policy conﬁguration ﬁles that's designed to meet everyday security goals. For more information about SELinux features and functionality, see SELinux Notebook and Policy Languages". Setting SELinux modes for AL2023 535 Amazon Linux 2023 Topics • Default SELinux status and modes for AL2023 • Change to enforcing mode • Option to disable SELinux for AL2023 User Guide Default SELinux status and modes for AL2023 For AL2023, SELinux by default is enabled and set to permissive mode. In permissive mode, permission denials are logged but not enforced. The getenforce or sestatus commands tell you the current SELinux status, policy, and mode. With the default status set to enabled and permissive, the getenforce command returns permissive. The sestatus command returns the SELinux status and the current SELinux policy as shown in the following example: $ sestatus SELinux status: enabled SELinuxfs mount: /sys/fs/selinux SELinux root directory: /etc/selinux Loaded policy name: targeted Current mode: permissive Mode from config file: permissive Policy MLS status: enabled Policy deny_unknown status: allowed Memory protection checking: actual (secure) Max kernel policy version: 33 When you run SELinux in permissive mode, users might label ﬁles incorrectly. When you run SELinux in the disabled status, ﬁles aren't labeled. Both incorrect or unlabeled ﬁles can cause problems when you change to enforcing mode. SELinux automatically relabels ﬁles to avoid this problem. SELinux prevents labeling problems with automatic relabeling when you change the status to enabled. Default SELinux status and modes for AL2023 536 Amazon Linux 2023 User Guide Change to enforcing mode When you run SELinux in enforcing mode, the SELinux utility is enforcing the conﬁgured policy. SELinux governs the capabilities of select applications by allowing or denying access based on the policy’s rules. To ﬁnd the current SELinux mode, run the getenforce command. getenforce Permissive Edit conﬁg ﬁle to enable enforcing mode To change the mode to enforcing, use the following steps. 1. Edit the /etc/selinux/config ﬁle to change to enforcing mode. The SELINUX setting should look like the following example. SELINUX=enforcing 2. Restart your system to complete the change to enforcing mode. $ sudo reboot On the next boot, SELinux relabels all ﬁles and directories in the system. SELinux also adds the SELinux context for ﬁles and directories that were created when SELinux was disabled. After changing to enforcing mode, SELinux might deny some actions because of incorrect or missing SELinux policy rules. You can view the actions that SELinux denies with the following command. $ sudo ausearch -m AVC,USER_AVC,SELINUX_ERR,USER_SELINUX_ERR -ts recent Use cloud-init to enable enforcing mode As an alternative, when you launch your instance, pass the following cloud-config as user-data to enable enforcing mode. #cloud-config Change to enforcing mode 537 Amazon Linux 2023 selinux: mode: enforcing User Guide By default, this setting causes the instance to reboot. For greater stability, we recommend rebooting your instance. However, if you prefer, you can skip the reboot by providing the following cloud-config. #cloud-config selinux: mode: enforcing selinux_no_reboot: 1 Option to disable SELinux for AL2023 When you disable SELinux, SELinux policy isn't loaded or enforced and Access Vector Cache (AVC) messages aren't logged. You lose all beneﬁts of running SELinux. Instead of disabling SELinux, we recommend using permissive mode. It costs only a little more to run in permissive mode than it does to disable SELinux completely. Transitioning from permissive mode to enforcing mode requires much less of a conﬁguration adjustment than transitioning back to enforcing mode after disabling SELinux. You can label ﬁles, and the system can track and log actions that the active policy might have denied. Change SELinux to permissive mode When you run SELinux in permissive mode, SELinux policy isn’t enforced. In permissive mode, SELinux logs AVC messages but doesn’t deny operations. You can use these AVC messages for troubleshooting, debugging, and SELinux policy improvements. To change SELinux to permissive mode, use the following steps. 1. Edit the /etc/selinux/config ﬁle to change
al2023-ug-120	al2023-ug.pdf	120	completely. Transitioning from permissive mode to enforcing mode requires much less of a conﬁguration adjustment than transitioning back to enforcing mode after disabling SELinux. You can label ﬁles, and the system can track and log actions that the active policy might have denied. Change SELinux to permissive mode When you run SELinux in permissive mode, SELinux policy isn’t enforced. In permissive mode, SELinux logs AVC messages but doesn’t deny operations. You can use these AVC messages for troubleshooting, debugging, and SELinux policy improvements. To change SELinux to permissive mode, use the following steps. 1. Edit the /etc/selinux/config ﬁle to change to permissive mode. The SELINUX value should look like the following example. SELINUX=permissive 2. Restart your system to complete the change to permissive mode. sudo reboot Option to disable SELinux 538 Amazon Linux 2023 Disable SELinux User Guide When you disable SELinux, SELinux policy isn't loaded or enforced, and AVC messages aren't logged. You lose all beneﬁts of running SELinux. To disable SELinux, use the following steps. 1. Ensure that the grubby package is installed. rpm -q grubby grubby-version 2. Conﬁgure your bootloader to add selinux=0 to the kernel command line. sudo grubby --update-kernel ALL --args selinux=0 3. Restart your system. sudo reboot 4. Run the getenforce command to conﬁrm that SELinux is Disabled. $ getenforce Disabled For more information about SELinux, see the SELinux Notebook and SELinux conﬁguration. Enable FIPS Mode on AL2023 This section explains how to enable Federal Information Processing Standards (FIPS) on AL2023. For more information about FIPS, see: • Federal Information Processing Standard (FIPS) • Compliance FAQs: Federal Information Processing Standards Enable FIPS Mode on AL2023 539 Amazon Linux 2023 Note User Guide This section documents how to enable FIPS mode in AL2023, it doesn't cover the certiﬁcation status of AL2023 cryptographic modules. Prerequisites • An existing AL2023 (AL2023.2 or higher) Amazon EC2 instance with access to the internet to download required packages. For more information about launching an AL2023 Amazon EC2 instance, see Launching AL2023 using the Amazon EC2 console. • You must connect to your Amazon EC2 instance using SSH or AWS Systems Manager. For more information, see Connecting to AL2023 instances. Important ED25519 SSH user keys aren't supported in FIPS mode. If you launched your Amazon EC2 instance using an ED25519 SSH key pair, you must generate new keys using another algorithm (such as RSA) or you may lose access to your instance after enabling FIPS mode. For more information see Create key pairs in the Amazon EC2 User Guide. Enable FIPS Mode 1. Connect to your AL2023 instance using SSH or AWS Systems Manager. 2. Ensure the system is up to date. For more information, see Manage package and operating system updates in AL2023. 3. Ensure the crypto-policies utilities are installed and up-to-date. sudo dnf -y install crypto-policies crypto-policies-scripts 4. Enable FIPS mode by running the following command. This will enable FIPS mode system- wide for the modules listed in the AL2023 FAQ sudo fips-mode-setup --enable 5. Reboot the instance using the following command. Enable FIPS Mode on AL2023 540 Amazon Linux 2023 sudo reboot User Guide 6. To verify that FIPS mode is enabled, reconnect to your instance and run the following command. sudo fips-mode-setup --check The following example output shows FIPS mode is enabled: FIPS mode is enabled. Enable FIPS Mode in an AL2023 Container This section explains how to enable Federal Information Processing Standards (FIPS) in an AL2023 container. For more information about FIPS, see: • Federal Information Processing Standard (FIPS) • Compliance FAQs: Federal Information Processing Standards Note This section documents how to enable FIPS mode in an AL2023 container. It does not cover the certiﬁcation status of AL2023 cryptographic modules. Prerequisites • An existing AL2023 (AL2023.2 or higher) Amazon EC2 instance with access to the internet to download required packages. For more information about launching an AL2023 Amazon EC2 instance, see Launching AL2023 using the Amazon EC2 console. • You must connect to your Amazon EC2 instance using SSH or AWS Systems Manager. For more information, see Connecting to AL2023 instances. Enable FIPS Mode in an AL2023 Container 541 Amazon Linux 2023 Important User Guide The fips-mode-setup command will not work correctly from within the container. Please read the steps below to properly conﬁgure FIPS mode in an AL2023 container. Enable FIPS Mode in an AL2023 Container 1. FIPS mode must ﬁrst be enabled on the AL2023 container Host. Follow the instructions at Enable FIPS Mode on AL2023 to enable FIPS mode on the Host. 2. Connect to your AL2023 container host instance using SSH or AWS Systems Manager. 3. FIPS mode will be automatically enabled in an AL2023 container if the AL2023 host is in FIPS mode and /proc/sys/crypto/fips_enabled is accessible from within the container. If the contents of /proc/sys/crypto/fips_enabled is 0 then FIPS is
al2023-ug-121	al2023-ug.pdf	121	Please read the steps below to properly conﬁgure FIPS mode in an AL2023 container. Enable FIPS Mode in an AL2023 Container 1. FIPS mode must ﬁrst be enabled on the AL2023 container Host. Follow the instructions at Enable FIPS Mode on AL2023 to enable FIPS mode on the Host. 2. Connect to your AL2023 container host instance using SSH or AWS Systems Manager. 3. FIPS mode will be automatically enabled in an AL2023 container if the AL2023 host is in FIPS mode and /proc/sys/crypto/fips_enabled is accessible from within the container. If the contents of /proc/sys/crypto/fips_enabled is 0 then FIPS is not enabled, and a value of 1 indicates that FIPS mode is enabled. You can verify that FIPS is enabled by running the following command on both the AL2023 host and container: cat /proc/sys/crypto/fips_enabled 4. Next, enable the FIPS crypto-policies within the container. There are several ways to accomplish this, described in the options below. Use the option that works best for your environment. a. Enable the FIPS crypto-policies manually within the container using the update-crypto- policies command: # Run these commands inside the container dnf install -y crypto-policies-scripts update-crypto-policies --set FIPS b. Create bind mounts within the AL2023 container (this is similar to how podman works in other distributions): # Run these commands inside the container mount --bind /usr/share/crypto-policies/back-ends/FIPS /etc/crypto-policies/back- ends echo "FIPS" > /usr/share/crypto-policies/default-fips-config Enable FIPS Mode in an AL2023 Container 542 Amazon Linux 2023 User Guide mount --bind /usr/share/crypto-policies/default-fips-config /etc/crypto-policies/ config c. It is also possible to create a bind mount so that the AL2023 container matches the AL2023 host's crypto-policies. The following is only provided as an example. This conﬁguration could cause issues if there are incompatible diﬀerences in the crypto-policies and package versions between the container and host: sudo docker pull amazonlinux:2023 sudo docker run --mount type=bind,readonly,src=/etc/crypto-policies,dst=/etc/ crypto-policies -it amazonlinux:2023 5. After performing the steps above you can again verify that FIPS is enabled in the container with the following commands: $ cat /etc/crypto-policies/config FIPS $ cat /proc/sys/crypto/fips_enabled 1 Swap OpenSSL FIPS providers on AL2023 This section explains how to switch between the latest and certified OpenSSL FIPS providers on AL2023. For more information about FIPS, see: • Federal Information Processing Standard (FIPS) • Compliance FAQs: Federal Information Processing Standards • FedRAMP Policy for Cryptographic Module Selection and Use Important On AL2023.7 and higher, the default OpenSSL FIPS provider is the openssl-fips- provider-latest package, which receives regular bugﬁx and security updates. Swap OpenSSL FIPS providers on AL2023 543 Amazon Linux 2023 User Guide The instructions below are only for customers who want to pin to the openssl-fips- provider-certified package. This version of the FIPS provider will match the checksum on the NIST certiﬁcate, and may not have the latest updates. See the AL2023 FAQ for more information about FIPS certiﬁed modules and package versions. Prerequisites • An existing AL2023 (AL2023.7 or higher) Amazon EC2 instance with access to the internet to download required packages. For more information about launching an AL2023 Amazon EC2 instance, see Launching AL2023 using the Amazon EC2 console. • You must connect to your Amazon EC2 instance using SSH or AWS Systems Manager. For more information, see Connecting to AL2023 instances. • To enable FIPS mode on AL2023, follow the instructions at Enable FIPS Mode on AL2023. Switch between openssl-fips-provider-latest and openssl-fips-provider- certified 1. Use dnf to switch the OpenSSL FIPS provider: sudo dnf -y swap openssl-fips-provider-latest openssl-fips-provider-certified 2. Check that you are using the certiﬁed OpenSSL FIPS provider. With AL2023 in FIPS mode, run the following command: openssl list -providers You should see the following output: Providers: base name: OpenSSL Base Provider version: 3.2.2 status: active default name: OpenSSL Default Provider Swap OpenSSL FIPS providers on AL2023 544 Amazon Linux 2023 version: 3.2.2 status: active fips name: Amazon Linux 2023 - OpenSSL FIPS Provider version: 3.0.8-d694bfa693b76001 status: active AL2023 Kernel Hardening User Guide The 6.1 Linux kernel in AL2023 is conﬁgured and built with several hardening options and features. Kernel Hardening options (architecture independent) CONFIG option AL2023/6.1/ aarch64 AL2023/6.1/ x86_64 AL2023/6.12/ aarch64 AL2023/6.12/ x86_64 n m y y CONFIG_AC PI_CUSTOM _METHOD CONFIG_BI NFMT_MISC CONFIG_BUG CONFIG_BU G_ON_DATA _CORRUPTI ON CONFIG_CF N/A I_CLANG CONFIG_CF I_PERMISS IVE N/A n m y y N/A N/A N/A N/A m y y N/A N/A m y y N/A N/A Kernel Hardening 545 Amazon Linux 2023 CONFIG option AL2023/6.1/ aarch64 AL2023/6.1/ x86_64 AL2023/6.12/ aarch64 AL2023/6.12/ x86_64 User Guide CONFIG_CO MPAT CONFIG_CO MPAT_BRK y n CONFIG_CO N/A MPAT_VDSO CONFIG_DE BUG_CREDE NTIALS CONFIG_DE BUG_LIST CONFIG_DE BUG_NOTIF IERS CONFIG_DE BUG_SG CONFIG_DE BUG_VIRTU AL CONFIG_DE BUG_WX n y n n n n y n n n y n n n n y n N/A N/A y n n n n y n n N/A y n n n n CONFIG_DE 65536 65536 65536 65536 FAULT_MMA P_MIN_ADDR CONFIG_DE N/A N/A N/A N/A
al2023-ug-122	al2023-ug.pdf	122	N/A N/A N/A m y y N/A N/A m y y N/A N/A Kernel Hardening 545 Amazon Linux 2023 CONFIG option AL2023/6.1/ aarch64 AL2023/6.1/ x86_64 AL2023/6.12/ aarch64 AL2023/6.12/ x86_64 User Guide CONFIG_CO MPAT CONFIG_CO MPAT_BRK y n CONFIG_CO N/A MPAT_VDSO CONFIG_DE BUG_CREDE NTIALS CONFIG_DE BUG_LIST CONFIG_DE BUG_NOTIF IERS CONFIG_DE BUG_SG CONFIG_DE BUG_VIRTU AL CONFIG_DE BUG_WX n y n n n n y n n n y n n n n y n N/A N/A y n n n n y n n N/A y n n n n CONFIG_DE 65536 65536 65536 65536 FAULT_MMA P_MIN_ADDR CONFIG_DE N/A N/A N/A N/A VKMEM Kernel Hardening options (architecture independent) 546 AL2023/6.1/ aarch64 AL2023/6.1/ x86_64 AL2023/6.12/ aarch64 AL2023/6.12/ x86_64 User Guide n n y y n n y y n n y y n n y y N/A N/A N/A N/A N/A N/A N/A N/A Amazon Linux 2023 CONFIG option CONFIG_DE VMEM CONFIG_EF I_DISABLE _PCI_DMA CONFIG_FO RTIFY_SOU RCE CONFIG_HA RDENED_US ERCOPY CONFIG_HA RDENED_US ERCOPY_FA LLBACK CONFIG_HA RDENED_US ERCOPY_PA GESPAN CONFIG_HI y BERNATION N/A CONFIG_HW _RANDOM_T PM y N/A y N/A y N/A CONFIG_IN m m m m ET_DIAG Kernel Hardening options (architecture independent) 547 Amazon Linux 2023 CONFIG option AL2023/6.1/ aarch64 AL2023/6.1/ x86_64 AL2023/6.12/ aarch64 AL2023/6.12/ x86_64 User Guide CONFIG_IN n IT_ON_ALL OC_DEFAUL T_ON CONFIG_IN n n n n n n n IT_ON_FRE E_DEFAULT _ON CONFIG_IN IT_STACK_ ALL_ZERO N/A N/A N/A N/A CONFIG_IO n MMU_DEFAU LT_DMA_ST RICT CONFIG_IO y n y n y n y MMU_SUPPO RT CONFIG_IO _STRICT_D EVMEM CONFIG_KE XEC CONFIG_KF ENCE N/A N/A N/A N/A y n y n y n y n Kernel Hardening options (architecture independent) 548 Amazon Linux 2023 CONFIG option CONFIG_LD ISC_AUTOL OAD CONFIG_LE GACY_PTYS CONFIG_LO CK_DOWN_K ERNEL_FOR CE_CONFID ENTIALITY CONFIG_MO DULES CONFIG_MO DULE_SIG CONFIG_MO DULE_SIG_ ALL CONFIG_MO DULE_SIG_ FORCE AL2023/6.1/ aarch64 AL2023/6.1/ x86_64 AL2023/6.12/ aarch64 AL2023/6.12/ x86_64 User Guide n n n y y y n n n n y y y n n n n y y y n n n n y y y n CONFIG_MO sha512 sha512 sha512 sha512 DULE_SIG_ HASH CONFIG_MO certs/sig certs/sig certs/sig certs/sig DULE_SIG_ ning_key. ning_key. ning_key. ning_key. KEY pem pem pem pem Kernel Hardening options (architecture independent) 549 Amazon Linux 2023 CONFIG option AL2023/6.1/ aarch64 AL2023/6.1/ x86_64 AL2023/6.12/ aarch64 AL2023/6.12/ x86_64 User Guide y n y n y n y n N/A N/A N/A N/A N/A N/A N/A N/A y 0 y n y 0 y n y 0 y n y 0 y n CONFIG_MO DULE_SIG_ SHA512 CONFIG_PA GE_POISON ING CONFIG_PA GE_POISON ING_NO_SA NITY CONFIG_PA GE_POISON ING_ZERO CONFIG_PA NIC_ON_OO PS CONFIG_PA NIC_TIMEO UT CONFIG_PR OC_KCORE CONFIG_RA NDOMIZE_K STACK_OFF SET_DEFAU LT Kernel Hardening options (architecture independent) 550 Amazon Linux 2023 CONFIG option AL2023/6.1/ aarch64 AL2023/6.1/ x86_64 AL2023/6.12/ aarch64 AL2023/6.12/ x86_64 User Guide CONFIG_RA y NDOM_TRUS T_BOOTLOA DER CONFIG_RA y y y N/A N/A N/A N/A NDOM_TRUS T_CPU CONFIG_RE FCOUNT_FU LL N/A N/A N/A N/A CONFIG_SC N/A HED_CORE CONFIG_SC HED_STACK _END_CHECK CONFIG_SE CCOMP CONFIG_SE CCOMP_FIL TER CONFIG_SE CURITY CONFIG_SE CURITY_DM ESG_RESTR ICT y y y y y y y y y y y N/A y y y y y y y y y y y Kernel Hardening options (architecture independent) 551 AL2023/6.1/ aarch64 AL2023/6.1/ x86_64 AL2023/6.12/ aarch64 AL2023/6.12/ x86_64 User Guide Amazon Linux 2023 CONFIG option CONFIG_SE CURITY_LA NDLOCK CONFIG_SE CURITY_LO CKDOWN_LSM CONFIG_SE CURITY_LO CKDOWN_LS M_EARLY n y y CONFIG_SE y CURITY_SE LINUX_BOO TPARAM CONFIG_SE y CURITY_SE LINUX_DEV ELOP CONFIG_SE n n y y y y n n y y y y n y y y y N/A N/A CURITY_SE LINUX_DIS ABLE CONFIG_SE CURITY_WR ITABLE_HO OKS N/A N/A N/A N/A Kernel Hardening options (architecture independent) 552 Amazon Linux 2023 CONFIG option AL2023/6.1/ aarch64 AL2023/6.1/ x86_64 AL2023/6.12/ aarch64 AL2023/6.12/ x86_64 User Guide y y CONFIG_SE CURITY_YA MA CONFIG_SH UFFLE_PAG E_ALLOCAT OR CONFIG_SL y AB_FREELI ST_HARDEN ED CONFIG_SL AB_FREELI ST_RANDOM CONFIG_SL UB_DEBUG CONFIG_ST ACKPROTEC TOR CONFIG_ST ACKPROTEC TOR_STRONG CONFIG_ST ATIC_USER MODEHELPER y y y y n y y y y y y y n y y y y y y y n y y y y y y y n Kernel Hardening options (architecture independent) 553 Amazon Linux 2023 CONFIG option CONFIG_ST RICT_DEVM EM CONFIG_ST RICT_KERN EL_RWX CONFIG_ST RICT_MODU LE_RWX CONFIG_SY N_COOKIES CONFIG_VM AP_STACK CONFIG_WE RROR CONFIG_ZE RO_CALL_U SED_REGS AL2023/6.1/ aarch64 AL2023/6.1/ x86_64 AL2023/6.12/ aarch64 AL2023/6.12/ x86_64 User Guide n y y y y n n n y y y y n n n y y y y n n n y y y y n n Allow ACPI methods to be inserted/replaced at runtime (CONFIG_ACPI_CUSTOM_METHOD) Amazon Linux disables this option as it allows root users to write to arbitrary kernel memory. This option is one of the Kernel Self Protection Project Recommended Settings. Kernel Hardening options (architecture independent) 554 Amazon Linux 2023 User Guide Miscellaneous Binary Formats (binfmt_misc) Although this option is one of the Kernel Self Protection Project (KSPP) Recommended
al2023-ug-123	al2023-ug.pdf	123	x86_64 AL2023/6.12/ aarch64 AL2023/6.12/ x86_64 User Guide n y y y y n n n y y y y n n n y y y y n n n y y y y n n Allow ACPI methods to be inserted/replaced at runtime (CONFIG_ACPI_CUSTOM_METHOD) Amazon Linux disables this option as it allows root users to write to arbitrary kernel memory. This option is one of the Kernel Self Protection Project Recommended Settings. Kernel Hardening options (architecture independent) 554 Amazon Linux 2023 User Guide Miscellaneous Binary Formats (binfmt_misc) Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. In AL2023, this feature is optional, and is built as a kernel module. BUG() support This option is one of the Kernel Self Protection Project Recommended Settings. BUG() if kernel encounters data corruption in when checking kernel memory structures for validity Some parts of the Linux kernel will check the internal consistency of data structures and can BUG() when they detect data corruption. This option is one of the Kernel Self Protection Project Recommended Settings. COMPAT_BRK With this option disabled (which is how Amazon Linux conﬁgures the kernel), the randomize_va_space sysctl setting defaults to 2, which also enables heap randomization on top of mmap base, stack, and VDSO page randomization. This option exists in the kernel to provide compatibility with some ancient libc.so.5 binaries from 1996 and earlier. This option is one of the Kernel Self Protection Project Recommended Settings. COMPAT_VDSO This conﬁguration option is relevant to x86-64 and not aarch64. By setting this to n, the Amazon Linux kernel does not make a 32-bit virtual Dynamic Shared Object (VDSO) visible at a predictable address. The most recent glibc known to be broken by this option being set to n is glibc 2.3.3, from 2004. This option is one of the Kernel Self Protection Project Recommended Settings. Kernel Hardening options (architecture independent) 555 Amazon Linux 2023 User Guide CONFIG_DEBUG gated hardening Linux kernel conﬁguration options gated by CONFIG_DEBUG are typically designed for use in kernels built for debugging issues, and things like performance are not a priority. AL2023 enables the CONFIG_DEBUG_LIST hardening option. Disable DMA for PCI devices in EFI stub before conﬁguring the IOMMU Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. Hardening for copying memory between kernel and userspace When the kernel needs to copy memory to or from userspace, this option enables some checks which can protect against some classes of heap overﬂow issues. The CONFIG_HARDENED_USERCOPY_FALLBACK option existed in kernels 4.16 through 5.15 to help kernel developers discover any missing allowlist entries via a WARN(). Because AL2023 ships a 6.1 kernel, this option is no longer relevant to AL2023. The CONFIG_HARDENED_USERCOPY_PAGESPAN option existed in kernels primarily as a debugging option for developers and no longer applies to the 6.1 kernel in AL2023. This option is one of the Kernel Self Protection Project Recommended Settings. Hibernation Support Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. This option needs to be enabled in order to support the ability to Hibernate your On-Demand Instance, and to support the ability to Hibernate interrupted Spot Instances Random Number Generation The AL2023 kernel is conﬁgured to ensure adequate entropy is available for usage within EC2. CONFIG_INET_DIAG Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. In AL2023, this feature is optional, and is built as a kernel module. Kernel Hardening options (architecture independent) 556 Amazon Linux 2023 User Guide Zero all kernel page and slab allocator memory on allocation and deallocation Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. These options are disabled in AL2023 due to the possible performance impact of enabling this functionality by default. The CONFIG_INIT_ON_ALLOC_DEFAULT_ON behavior can be enabled by adding init_on_alloc=1 to the kernel command line, and the CONFIG_INIT_ON_FREE_DEFAULT_ON behavior can be enabled by adding init_on_free=1. Initialize all stack variables as zero (CONFIG_INIT_STACK_ALL_ZERO) Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. This option requires GCC 12 or higher, while AL2023 ships with GCC 11. Kernel Module Signing AL2023 signs and validates the signatures of kernel modules. The CONFIG_MODULE_SIG_FORCE option, which would require modules to have a valid signature is not enabled in order to preserve compatibility for users building third party modules. For users wanting to ensure that all kernel modules are
al2023-ug-124	al2023-ug.pdf	124	behavior can be enabled by adding init_on_free=1. Initialize all stack variables as zero (CONFIG_INIT_STACK_ALL_ZERO) Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. This option requires GCC 12 or higher, while AL2023 ships with GCC 11. Kernel Module Signing AL2023 signs and validates the signatures of kernel modules. The CONFIG_MODULE_SIG_FORCE option, which would require modules to have a valid signature is not enabled in order to preserve compatibility for users building third party modules. For users wanting to ensure that all kernel modules are signed, the Lockdown Linux Security Module (LSM) can be conﬁgured to enforce this. kexec Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. This option is enabled so that kdump functionality can be used. IOMMU Support AL2023 enables IOMMU support. The CONFIG_IOMMU_DEFAULT_DMA_STRICT option is not enabled by default, but this functionality can be conﬁgured by adding iommu.passthrough=0 iommu.strict=1 to the kernel command line. kfence Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. Kernel Hardening options (architecture independent) 557 Amazon Linux 2023 Legacy pty Support User Guide AL2023 uses the modern PTY interface (devpts). This option is one of the Kernel Self Protection Project Recommended Settings. Lockdown Linux Security Module (LSM) AL2023 builds the lockdown LSM, which will automatically lock down the kernel when using Secure Boot. The CONFIG_LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY option is not enabled. Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. When not using Secure Boot, it is possible to enable the lockdown LSM and conﬁgure as wanted. Page Poisoning Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. Similarly to Zero all kernel page and slab allocator memory on allocation and deallocation , this is disabled in the AL2023 kernel due to the possible impact on performance. Stack Protector The AL2023 kernel is built with the stack-protector feature of GCC enabled with the -fstack- protector-strong option. This option is one of the Kernel Self Protection Project Recommended Settings. seccomp BPF API The seccomp hardening feature is used by software such as systemd and container runtimes to harden userspace applications. This option is one of the Kernel Self Protection Project Recommended Settings. panic() timeout The AL2023 kernel is conﬁgured with this value set to 0, meaning that the kernel will not reboot after it panics. Although this option is one of the Kernel Self Protection Project (KSPP) Kernel Hardening options (architecture independent) 558 Amazon Linux 2023 User Guide Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. This is conﬁgurable through sysctl, /proc/sys/kernel/panic, and on the kernel command line. Security Models AL2023 enables SELinux in Permissive mode by default. For more information, see Setting SELinux modes for AL2023. The Lockdown Linux Security Module (LSM) and yama modules are also enabled. /proc/kcore Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. Kernel stack oﬀset randomization on syscall entry Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. This can be enabled by setting randomize_kstack_offset=on on the kernel command line. Reference counting checks (CONFIG_REFCOUNT_FULL) Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. This option is not curretly enabled due to its possible impact on performance. Scheduler awareness of SMT cores (CONFIG_SCHED_CORE) The AL2023 kernel is built with CONFIG_SCHED_CORE, which enables userspace applications to use prctl(PR_SCHED_CORE). This option is one of the Kernel Self Protection Project Recommended Settings. Check for stack corruption on calls to schedule() (CONFIG_SCHED_STACK_END_CHECK) The AL2023 kernel is built with CONFIG_SCHED_STACK_END_CHECK enabled. This option is one of the Kernel Self Protection Project Recommended Settings. Kernel Hardening options (architecture independent) 559 Amazon Linux 2023 User Guide Memory allocator hardening The AL2023 kernel enables hardening of the kernel memory allocator with the CONFIG_SHUFFLE_PAGE_ALLOCATOR, CONFIG_SLAB_FREELIST_HARDENED, and CONFIG_SLAB_FREELIST_RANDOM options. This option is one of the Kernel Self Protection Project Recommended Settings. SLUB debugging support The AL2023 kernel enables CONFIG_SLUB_DEBUG as this option enables optional debugging features for the allocator that can be enabled on the kernel command line. This option is one of the Kernel Self Protection Project Recommended Settings. CONFIG_STATIC_USERMODEHELPER Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023
al2023-ug-125	al2023-ug.pdf	125	Recommended Settings. Kernel Hardening options (architecture independent) 559 Amazon Linux 2023 User Guide Memory allocator hardening The AL2023 kernel enables hardening of the kernel memory allocator with the CONFIG_SHUFFLE_PAGE_ALLOCATOR, CONFIG_SLAB_FREELIST_HARDENED, and CONFIG_SLAB_FREELIST_RANDOM options. This option is one of the Kernel Self Protection Project Recommended Settings. SLUB debugging support The AL2023 kernel enables CONFIG_SLUB_DEBUG as this option enables optional debugging features for the allocator that can be enabled on the kernel command line. This option is one of the Kernel Self Protection Project Recommended Settings. CONFIG_STATIC_USERMODEHELPER Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. This is because CONFIG_STATIC_USERMODEHELPER requires special support from the distribution, which is not currently present in Amazon Linux. Read-Only kernel text and rodata (CONFIG_STRICT_KERNEL_RWX and CONFIG_STRICT_MODULE_RWX) The AL2023 kernel is conﬁgured to mark kernel and kernel module text and rodata memory as read-only, and non-text memory marked as not executable. This option is one of the Kernel Self Protection Project Recommended Settings. TCP syncookie support (CONFIG_SYN_COOKIES) The AL2023 kernel is built with support for TCP syncookies. This option is one of the Kernel Self Protection Project Recommended Settings. Virtually mapped stack with guard pages (CONFIG_VMAP_STACK) The AL2023 kernel is built with CONFIG_VMAP_STACK, enabling virtually mapped kernel stacks with guard pages. This option is one of the Kernel Self Protection Project Recommended Settings. Build with compiler warnings as errors (CONFIG_WERROR) Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. Kernel Hardening options (architecture independent) 560 Amazon Linux 2023 User Guide Register zeroing on function exit (CONFIG_ZERO_CALL_USED_REGS) Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. Minimum address for userspace allocation This hardening option can help reduce the impact of kernel NULL pointer bugs. This option is one of the Kernel Self Protection Project Recommended Settings. clang speciﬁc hardening options The AL2023 kernel is built with GCC rather than clang, so the CONFIG_CFI_CLANG hardening option cannot be enabled, which also makes CONFIG_CFI_PERMISSIVE not applicable. Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. x86-64 speciﬁc Kernel Hardening options CONFIG option AL2023/6.1/ aarch64 AL2023/6.1/ x86_64 AL2023/6.12/ aarch64 AL2023/6.12/ x86_64 CONFIG_AM N/A D_IOMMU CONFIG_AM D_IOMMU_V2 CONFIG_IA 32_EMULAT ION N/A N/A CONFIG_IN N/A TEL_IOMMU CONFIG_IN TEL_IOMMU _DEFAULT_ ON N/A y y y y n N/A N/A N/A N/A N/A y N/A y y n x86-64 speciﬁc Kernel Hardening options 561 AL2023/6.1/ aarch64 AL2023/6.1/ x86_64 AL2023/6.12/ aarch64 AL2023/6.12/ x86_64 User Guide Amazon Linux 2023 CONFIG option CONFIG_IN TEL_IOMMU _SVM CONFIG_LE GACY_VSYS CALL_NONE CONFIG_MO DIFY_LDT_ SYSCALL CONFIG_PA GE_TABLE_ ISOLATION CONFIG_RA NDOMIZE_M EMORY N/A N/A N/A N/A N/A CONFIG_X8 N/A 6_64 CONFIG_X8 N/A 6_MSR CONFIG_X8 6_VSYSCAL L_EMULATI ON N/A CONFIG_X8 N/A 6_X32 CONFIG_X8 N/A 6_X32_ABI n n n y y y y y N/A n N/A N/A N/A n n n N/A N/A N/A N/A N/A N/A N/A N/A y y y y N/A n x86-64 speciﬁc Kernel Hardening options 562 Amazon Linux 2023 x86-64 Support User Guide Base x86-64 support includes the Physical Address Extension (PAE) and no-execute (NX) bit support. This option is one of the Kernel Self Protection Project Recommended Settings. AMD and Intel IOMMU support The AL2023 kernel builds with support for the AMD and Intel IOMMUs. This option is one of the Kernel Self Protection Project Recommended Settings. The CONFIG_INTEL_IOMMU_DEFAULT_ON option is not set, but can be enabled by passing intel_iommu=on to the kernel command line. Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. The CONFIG_INTEL_IOMMU_SVM option is not currently enabled in AL2023. Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. Support for 32bit userspace Important Support for 32bit x86 userspace is deprecated and support for running 32bit userspace binaries might be removed in a future major version of Amazon Linux. Note While AL2023 no longer includes any 32bit packages, the kernel will still support running 32bit userspace. See 32bit x86 (i686) Packages for more information. To support running 32bit userspace applications, AL2023 does not enable the CONFIG_X86_VSYSCALL_EMULATION option, and enables the CONFIG_IA32_EMULATION, CONFIG_COMPAT, and CONFIG_X86_VSYSCALL_EMULATION options. Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. x86-64 speciﬁc Kernel Hardening options 563 Amazon Linux 2023 User Guide The x32 native 32-bit ABI for 64-bit processors is not enabled (CONFIG_X86_X32 and CONFIG_X86_X32_ABI). This option is one
al2023-ug-126	al2023-ug.pdf	126	Note While AL2023 no longer includes any 32bit packages, the kernel will still support running 32bit userspace. See 32bit x86 (i686) Packages for more information. To support running 32bit userspace applications, AL2023 does not enable the CONFIG_X86_VSYSCALL_EMULATION option, and enables the CONFIG_IA32_EMULATION, CONFIG_COMPAT, and CONFIG_X86_VSYSCALL_EMULATION options. Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. x86-64 speciﬁc Kernel Hardening options 563 Amazon Linux 2023 User Guide The x32 native 32-bit ABI for 64-bit processors is not enabled (CONFIG_X86_X32 and CONFIG_X86_X32_ABI). This option is one of the Kernel Self Protection Project Recommended Settings. x86 Model Speciﬁc Register (MSR) support The CONFIG_X86_MSR option is enabled in order to support turbostat. Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. modify_ldt syscall AL2023 does not allow user programs to modify the x86 Local Descriptor Table (LDT) with the modify_ldt syscall. This call is required to run 16-bit or segmented code, and its absence may break software such as dosemu, running some programs under WINE, and some very old threading libraries. This option is one of the Kernel Self Protection Project Recommended Settings. Remove kernel mapping in user mode AL2023 conﬁgures the kernel so that the majority of kernel addresses are not mapped into userspace. This option is one of the Kernel Self Protection Project Recommended Settings. Randomize kernel memory sections AL2023 conﬁgures the kernel to randomize the base virtual addresses of kernel memory sections. This option is one of the Kernel Self Protection Project Recommended Settings. aarch64 speciﬁc Kernel Hardening options CONFIG option AL2023/6.1/ aarch64 AL2023/6.1/ x86_64 AL2023/6.12/ aarch64 AL2023/6.12/ x86_64 CONFIG_AR y M64_BTI N/A CONFIG_AR M64_BTI_K ERNEL N/A N/A y N/A N/A N/A aarch64 speciﬁc Kernel Hardening options 564 Amazon Linux 2023 CONFIG option CONFIG_AR M64_PTR_A UTH CONFIG_AR M64_PTR_A UTH_KERNEL CONFIG_AR M64_SW_TT BR0_PAN CONFIG_UN MAP_KERNE L_AT_EL0 AL2023/6.1/ aarch64 AL2023/6.1/ x86_64 AL2023/6.12/ aarch64 AL2023/6.12/ x86_64 User Guide y y y y N/A N/A N/A N/A y y y y N/A N/A N/A N/A Branch Target Identiﬁcation The AL2023 kernel enables support for Branch Target Identiﬁcation (CONFIG_ARM64_BTI). This option is one of the Kernel Self Protection Project Recommended Settings. The CONFIG_ARM64_BTI_KERNEL option is not enabled in AL2023 as it is built with GCC, and support for building the kernel with this option is currently disabled in the upstream kernel due to a gcc bug. Although this option is one of the Kernel Self Protection Project (KSPP) Recommended Settings, AL2023 does not set this conﬁguration option to what KSPP recommends. Pointer Authentication (CONFIG_ARM64_PTR_AUTH) The AL2023 kernel is built with support for the Pointer Authentication extension (part of the ARMv8.3 Extensions), which can be used to help mitigate Return Oriented Programming (ROP) techniques. The required hardware support for pointer authentication on Graviton was introduced with Graviton 3. aarch64 speciﬁc Kernel Hardening options 565 Amazon Linux 2023 User Guide The CONFIG_ARM64_PTR_AUTH option is enabled and provides support for pointer authentication for userspace. Because the CONFIG_ARM64_PTR_AUTH_KERNEL option is also enabled, the AL2023 kernel is able to use the return address protection for itself. This option is one of the Kernel Self Protection Project Recommended Settings. Emulate Privileged Access Never using TTBR0_EL1 switching This option prevents the kernel from accessing userspace memory directly, with TTBR0_EL1 being only temporarily set to a valid value by the user access routines. This option is one of the Kernel Self Protection Project Recommended Settings. Unmap kernel when running in userspace The AL2023 kernel is conﬁgured to unmap the kernel when running in userspace (CONFIG_UNMAP_KERNEL_AT_EL0). This option is one of the Kernel Self Protection Project Recommended Settings. UEFI Secure Boot on AL2023 AL2023 supports UEFI Secure Boot starting with release 2023.1. You must use AL2023 with Amazon EC2 instances that support both UEFI and UEFI Secure Boot. For more information, see Requirements to launch an Amazon EC2 instance in UEFI boot mode in the Amazon EC2 User Guide. AL2023 instances with UEFI Secure Boot enabled accept only kernel level code, including the Linux kernel as well as modules, that are signed by Amazon so you can ensure that your instance only runs kernel level codes signed by AWS. For more information about Amazon EC2 instances and UEFI Secure Boot, see UEFI Secure Boot for Amazon Amazon EC2 instances in the Amazon EC2 User Guide. Prerequisites • You must be using an AMI with AL2023 release 2023.1 or higher. • The instance type must support UEFI Secure Boot. For more information, see Requirements to launch an Amazon EC2 instance in UEFI boot mode in the Amazon EC2 User Guide. UEFI Secure Boot on AL2023 566 Amazon Linux 2023 User Guide Enable UEFI Secure Boot on AL2023 Standard AL2023 AMIs incorporate a bootloader and
al2023-ug-127	al2023-ug.pdf	127	kernel level codes signed by AWS. For more information about Amazon EC2 instances and UEFI Secure Boot, see UEFI Secure Boot for Amazon Amazon EC2 instances in the Amazon EC2 User Guide. Prerequisites • You must be using an AMI with AL2023 release 2023.1 or higher. • The instance type must support UEFI Secure Boot. For more information, see Requirements to launch an Amazon EC2 instance in UEFI boot mode in the Amazon EC2 User Guide. UEFI Secure Boot on AL2023 566 Amazon Linux 2023 User Guide Enable UEFI Secure Boot on AL2023 Standard AL2023 AMIs incorporate a bootloader and a kernel signed by our keys. You can enable UEFI Secure Boot either by enrolling existing instances or creating AMIs with UEFI Secure Boot pre- enabled by registering an image from a snapshot. UEFI Secure Boot isn't enabled by default on the standard AL2023 AMIs. The boot mode of AL2023 AMIs is set to uefi-preferred which ensures that instances launched with these AMIs will use the UEFI ﬁrmware, if the instance type supports UEFI. If the instance type doesn't support UEFI, the instance is launched with Legacy BIOS ﬁrmware. When an instance launches in Legacy BIOS mode, UEFI Secure Boot isn't enforced. For more information about AMI boot modes on Amazon EC2 instances, see Instance launch behavior with Amazon Amazon EC2 boot modes in the Amazon EC2 User Guide. Topics • Enrollment of an existing instance • Register image from snapshot • Revocation updates • How UEFI Secure Boot works on AL2023 • Enrolling your own keys Enrollment of an existing instance To enroll an existing instance, populate the speciﬁc UEFI ﬁrmware variables with a set of keys that enable the ﬁrmware to verify the bootloader and the bootloader to verify the kernel on the next boot. 1. Amazon Linux provides a tool to simplify the enrollment process. Run the following command to provision the instance with the necessary set of keys and certiﬁcates. sudo amazon-linux-sb enroll 2. Run the following command to reboot the instance. After the instance is rebooted, UEFI Secure Boot will be enabled. sudo reboot Enable UEFI Secure Boot on AL2023 567 Amazon Linux 2023 Note User Guide Amazon Linux AMIs currently don't support Nitro Trusted Platform Module (NitroTPM). If you need NitroTPM in addition to UEFI Secure Boot, use the information in the following section. Register image from snapshot When registering an AMI from a snapshot of an Amazon EBS root volume using the Amazon EC2 register-image API, you can provision the AMI with a binary blob that contains the state of the UEFI variable store. By providing the AL2023 UefiData, you enable UEFI Secure Boot and don't need to follow the steps in the previous section. For more information about creating and using a binary blob, see Create a binary blob containing a pre-ﬁlled variable store in the Amazon EC2 User Guide. AL2023 provides a pre-built binary blob that can be used directly on Amazon EC2 instances. The binary blob is located in /usr/share/amazon-linux-sb-keys/uefi.vars on an running instance. This blob is provided by the amazon-linux-sb-keys RPM package which is installed by default on AL2023 AMIs starting with release 2023.1. Note To ensure that you are using the latest version of keys and revocations, use the blob from the same release of AL2023 that you use to create the AMI. When registering an image, we recommend using the BootMode parameter of the RegisterImage API set to uefi. This allows you to enable NitroTPM by setting the TpmSupport parameter to v2.0. Also, setting BootMode to uefi ensures that UEFI Secure Boot is enabled and can't be disabled by accident when switching to an instance type that doesn't support UEFI. For more information about NitroTPM, see NitroTPM for Amazon Amazon EC2 instances in the Amazon EC2 User Guide. Register image from snapshot 568 Amazon Linux 2023 Revocation updates User Guide It may be necessary for Amazon Linux to distribute a new version of the bootloader grub2 or the Linux kernel signed with updated keys. In that case, the old key may need to be revoked to prevent the chance of allowing exploitable bugs from previous versions of the bootloader to bypass the UEFI Secure Boot veriﬁcation process. Package updates to the grub2or kernel packages always automatically update the list of revocations into the UEFI variable store of the running instance. This means that with UEFI Secure Boot enabled, you can no longer run the old version of a package after installing a security update for the package. How UEFI Secure Boot works on AL2023 Unlike other Linux distributions, Amazon Linux doesn’t provide an additional component, called a shim, to act as the ﬁrst stage bootloader. The shim is generally signed with Microsoft keys. For example, on Linux distributions with the shim, the shim loads the grub2 bootloader
al2023-ug-128	al2023-ug.pdf	128	Package updates to the grub2or kernel packages always automatically update the list of revocations into the UEFI variable store of the running instance. This means that with UEFI Secure Boot enabled, you can no longer run the old version of a package after installing a security update for the package. How UEFI Secure Boot works on AL2023 Unlike other Linux distributions, Amazon Linux doesn’t provide an additional component, called a shim, to act as the ﬁrst stage bootloader. The shim is generally signed with Microsoft keys. For example, on Linux distributions with the shim, the shim loads the grub2 bootloader which uses the shim’s own code to verify the Linux kernel. Additionally, the shim maintains its own set of keys and revocations in the Machine Owner Key (MOK) database located in the UEFI variable store and controlled with the mokutil tool. Amazon Linux doesn’t provide a shim. Because the AMI owner controls the UEFI variables, this intermediary step isn't needed and would adversely aﬀect launch and boot times. Also, we chose not to include trust to any vendor keys by default, to reduce the chance that undesired binaries could get executed. As always, customers can include binaries if they chose to do so. With Amazon Linux, UEFI directly loads and veriﬁes our grub2 bootloader. The grub2 bootloader was modiﬁed to use UEFI to verify the Linux kernel after loading it. Thus, the Linux Kernel is veriﬁed using the same certiﬁcates stored in the normal UEFI db variable (authorized key database) and tested against the same dbx variable (revocations database) as the bootloader and other UEFI binaries. Because we provide our own PK and KEK keys, which control access to the db database and the dbx database, we can distribute signed updates and revocations as needed without an intermediary such as the shim. For more information about UEFI Secure Boot, see How UEFI Secure Boot works with Amazon Amazon EC2 instances in the Amazon EC2 User Guide. Revocation updates 569 Amazon Linux 2023 User Guide Enrolling your own keys As documented in the previous section, Amazon Linux does not require a shim for UEFI Secure Boot on Amazon EC2. When you're reading documentation for other Linux distributions, you may ﬁnd documentation for managing the Machine Owner Key (MOK) database using mokutil, which is not present on AL2023. The shim and MOK environments work around some limitations of key enrollment in UEFI Firmware that aren't applicable to how Amazon EC2 implements UEFI Secure Boot. With Amazon EC2 there are mechanisms to easily directly manipulate the keys in the UEFI variable store. If you want to enroll your own keys, you can do so either by manipulating the variable store within an existing instance (see Add keys to the variable store from within the instance) or by constructing a binary blob that's preﬁlled (see Create a binary blob containing a pre-ﬁlled variable store). Enrolling your own keys 570
amazon-appflow-api-001	amazon-appflow-api.pdf	1	API Reference AmazonAppFlow API Version 2020-08-23 Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AmazonAppFlow API Reference AmazonAppFlow: API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. 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 aﬃliated with, connected to, or sponsored by Amazon. AmazonAppFlow Table of Contents API Reference Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 2 CancelFlowExecutions .................................................................................................................................. 3 Request Syntax ........................................................................................................................................ 3 URI Request Parameters ........................................................................................................................ 3 Request Body ........................................................................................................................................... 4 Response Syntax ...................................................................................................................................... 4 Response Elements ................................................................................................................................. 5 Errors .......................................................................................................................................................... 5 See Also ..................................................................................................................................................... 6 CreateConnectorProﬁle ............................................................................................................................... 7 Request Syntax ........................................................................................................................................ 7 URI Request Parameters ...................................................................................................................... 13 Request Body ......................................................................................................................................... 13 Response Syntax ................................................................................................................................... 15 Response Elements ............................................................................................................................... 16 Errors ....................................................................................................................................................... 16 Examples ................................................................................................................................................. 17 See Also .................................................................................................................................................. 22 CreateFlow ................................................................................................................................................... 24 Request Syntax ...................................................................................................................................... 24 URI Request Parameters ...................................................................................................................... 30 Request Body ......................................................................................................................................... 30 Response Syntax ................................................................................................................................... 33 Response Elements ............................................................................................................................... 33 Errors ....................................................................................................................................................... 34 Examples ................................................................................................................................................. 35 See Also .................................................................................................................................................. 44 DeleteConnectorProﬁle ............................................................................................................................. 45 Request Syntax ...................................................................................................................................... 45 URI Request Parameters ...................................................................................................................... 45 Request Body ......................................................................................................................................... 45 Response Syntax ................................................................................................................................... 46 Response Elements ............................................................................................................................... 46 API Version 2020-08-23 iii AmazonAppFlow API Reference Errors ....................................................................................................................................................... 46 Examples ................................................................................................................................................. 46 See Also .................................................................................................................................................. 47 DeleteFlow ................................................................................................................................................... 49 Request Syntax ...................................................................................................................................... 49 URI Request Parameters ...................................................................................................................... 49 Request Body ......................................................................................................................................... 49 Response Syntax ................................................................................................................................... 50 Response Elements ............................................................................................................................... 50 Errors ....................................................................................................................................................... 50 Examples ................................................................................................................................................. 50 See Also .................................................................................................................................................. 51 DescribeConnector ..................................................................................................................................... 53 Request Syntax ...................................................................................................................................... 53 URI Request Parameters ...................................................................................................................... 53 Request Body ......................................................................................................................................... 53 Response Syntax ................................................................................................................................... 54 Response Elements ............................................................................................................................... 57 Errors ....................................................................................................................................................... 57 Examples ................................................................................................................................................. 58 See Also .................................................................................................................................................. 61 DescribeConnectorEntity .......................................................................................................................... 62 Request Syntax ...................................................................................................................................... 62 URI Request Parameters ...................................................................................................................... 62 Request Body ......................................................................................................................................... 62 Response Syntax ................................................................................................................................... 63 Response Elements ............................................................................................................................... 64 Errors ....................................................................................................................................................... 65 Examples ................................................................................................................................................. 66 See Also ................................................................................................................................................ 107 DescribeConnectorProﬁles ..................................................................................................................... 108 Request Syntax .................................................................................................................................... 108 URI Request Parameters ................................................................................................................... 108 Request Body ....................................................................................................................................... 108 Response Syntax ................................................................................................................................. 110 Response Elements ............................................................................................................................ 112 API Version 2020-08-23 iv AmazonAppFlow API Reference Errors ..................................................................................................................................................... 113 Examples ............................................................................................................................................... 113 See Also ................................................................................................................................................ 116 DescribeConnectors ................................................................................................................................. 117 Request Syntax .................................................................................................................................... 117 URI Request Parameters ................................................................................................................... 117 Request Body ....................................................................................................................................... 117 Response Syntax ................................................................................................................................. 118 Response Elements ............................................................................................................................ 122 Errors ..................................................................................................................................................... 123 Examples ............................................................................................................................................... 123 See Also ................................................................................................................................................ 127 DescribeFlow ............................................................................................................................................. 129 Request Syntax .................................................................................................................................... 129 URI Request Parameters ................................................................................................................... 129 Request Body ....................................................................................................................................... 129 Response Syntax ................................................................................................................................. 129 Response Elements ............................................................................................................................ 137 Errors ..................................................................................................................................................... 140 Examples ............................................................................................................................................... 141 See Also ................................................................................................................................................ 143 DescribeFlowExecutionRecords ............................................................................................................. 145 Request Syntax .................................................................................................................................... 145 URI Request Parameters ................................................................................................................... 145 Request Body ....................................................................................................................................... 145 Response Syntax ................................................................................................................................. 146 Response Elements ............................................................................................................................ 147 Errors ..................................................................................................................................................... 147 Examples ............................................................................................................................................... 148 See Also ................................................................................................................................................ 151 ListConnectorEntities .............................................................................................................................. 153 Request Syntax .................................................................................................................................... 153 URI Request Parameters ................................................................................................................... 153 Request Body ....................................................................................................................................... 153 Response Syntax ................................................................................................................................. 155 Response Elements ............................................................................................................................ 155 API Version 2020-08-23 v AmazonAppFlow API Reference Errors ..................................................................................................................................................... 156 Examples ............................................................................................................................................... 157 See Also ................................................................................................................................................ 161 ListConnectors .......................................................................................................................................... 162 Request Syntax .................................................................................................................................... 162 URI Request Parameters ................................................................................................................... 162 Request Body ....................................................................................................................................... 162 Response Syntax ................................................................................................................................. 163 Response Elements ............................................................................................................................ 163 Errors ..................................................................................................................................................... 164 Examples ............................................................................................................................................... 164 See Also ................................................................................................................................................ 165 ListFlows .................................................................................................................................................... 167 Request Syntax .................................................................................................................................... 167 URI Request Parameters ................................................................................................................... 167 Request Body ....................................................................................................................................... 167 Response Syntax ................................................................................................................................. 168 Response Elements ............................................................................................................................ 168 Errors ..................................................................................................................................................... 169 Examples ............................................................................................................................................... 169 See Also ................................................................................................................................................ 170 ListTagsForResource ................................................................................................................................ 172 Request Syntax .................................................................................................................................... 172 URI Request Parameters ................................................................................................................... 172 Request Body ....................................................................................................................................... 172 Response Syntax ................................................................................................................................. 172 Response Elements ............................................................................................................................ 172 Errors ..................................................................................................................................................... 173 See Also ................................................................................................................................................ 174 RegisterConnector .................................................................................................................................... 175 Request Syntax .................................................................................................................................... 175 URI Request Parameters ................................................................................................................... 175 Request Body ....................................................................................................................................... 175 Response Syntax ................................................................................................................................. 177 Response Elements ............................................................................................................................ 177 Errors ..................................................................................................................................................... 177 API Version 2020-08-23 vi AmazonAppFlow API Reference Examples ............................................................................................................................................... 179 See Also ................................................................................................................................................ 179 ResetConnectorMetadataCache ............................................................................................................ 181 Request Syntax .................................................................................................................................... 181 URI Request Parameters ................................................................................................................... 181 Request Body ....................................................................................................................................... 181 Response Syntax ................................................................................................................................. 184 Response Elements ............................................................................................................................ 184 Errors ..................................................................................................................................................... 184 Examples ............................................................................................................................................... 184 See Also ................................................................................................................................................ 185 StartFlow ................................................................................................................................................... 187 Request Syntax .................................................................................................................................... 187 URI Request Parameters ................................................................................................................... 187 Request Body ....................................................................................................................................... 187 Response Syntax ................................................................................................................................. 188 Response Elements ............................................................................................................................ 188 Errors ..................................................................................................................................................... 189 Examples ............................................................................................................................................... 190 See Also ................................................................................................................................................ 190 StopFlow .................................................................................................................................................... 192 Request Syntax .................................................................................................................................... 192 URI Request Parameters ................................................................................................................... 192 Request Body ....................................................................................................................................... 192 Response Syntax ................................................................................................................................. 192 Response Elements ............................................................................................................................ 193 Errors ..................................................................................................................................................... 193 Examples ............................................................................................................................................... 194 See Also ................................................................................................................................................ 194 TagResource .............................................................................................................................................. 196 Request Syntax .................................................................................................................................... 196 URI Request Parameters ................................................................................................................... 196 Request Body
amazon-appflow-api-002	amazon-appflow-api.pdf	2	Response Syntax ................................................................................................................................. 184 Response Elements ............................................................................................................................ 184 Errors ..................................................................................................................................................... 184 Examples ............................................................................................................................................... 184 See Also ................................................................................................................................................ 185 StartFlow ................................................................................................................................................... 187 Request Syntax .................................................................................................................................... 187 URI Request Parameters ................................................................................................................... 187 Request Body ....................................................................................................................................... 187 Response Syntax ................................................................................................................................. 188 Response Elements ............................................................................................................................ 188 Errors ..................................................................................................................................................... 189 Examples ............................................................................................................................................... 190 See Also ................................................................................................................................................ 190 StopFlow .................................................................................................................................................... 192 Request Syntax .................................................................................................................................... 192 URI Request Parameters ................................................................................................................... 192 Request Body ....................................................................................................................................... 192 Response Syntax ................................................................................................................................. 192 Response Elements ............................................................................................................................ 193 Errors ..................................................................................................................................................... 193 Examples ............................................................................................................................................... 194 See Also ................................................................................................................................................ 194 TagResource .............................................................................................................................................. 196 Request Syntax .................................................................................................................................... 196 URI Request Parameters ................................................................................................................... 196 Request Body ....................................................................................................................................... 196 Response Syntax ................................................................................................................................. 197 Response Elements ............................................................................................................................ 197 Errors ..................................................................................................................................................... 197 API Version 2020-08-23 vii AmazonAppFlow API Reference See Also ................................................................................................................................................ 198 UnregisterConnector ............................................................................................................................... 199 Request Syntax .................................................................................................................................... 199 URI Request Parameters ................................................................................................................... 199 Request Body ....................................................................................................................................... 199 Response Syntax ................................................................................................................................. 200 Response Elements ............................................................................................................................ 200 Errors ..................................................................................................................................................... 200 Examples ............................................................................................................................................... 200 See Also ................................................................................................................................................ 201 UntagResource .......................................................................................................................................... 202 Request Syntax .................................................................................................................................... 202 URI Request Parameters ................................................................................................................... 202 Request Body ....................................................................................................................................... 202 Response Syntax ................................................................................................................................. 202 Response Elements ............................................................................................................................ 203 Errors ..................................................................................................................................................... 203 See Also ................................................................................................................................................ 203 UpdateConnectorProﬁle ......................................................................................................................... 205 Request Syntax .................................................................................................................................... 205 URI Request Parameters ................................................................................................................... 211 Request Body ....................................................................................................................................... 211 Response Syntax ................................................................................................................................. 212 Response Elements ............................................................................................................................ 212 Errors ..................................................................................................................................................... 213 Examples ............................................................................................................................................... 213 See Also ................................................................................................................................................ 215 UpdateConnectorRegistration ............................................................................................................... 216 Request Syntax .................................................................................................................................... 216 URI Request Parameters ................................................................................................................... 216 Request Body ....................................................................................................................................... 216 Response Syntax ................................................................................................................................. 218 Response Elements ............................................................................................................................ 218 Errors ..................................................................................................................................................... 218 See Also ................................................................................................................................................ 220 UpdateFlow ............................................................................................................................................... 221 API Version 2020-08-23 viii AmazonAppFlow API Reference Request Syntax .................................................................................................................................... 221 URI Request Parameters ................................................................................................................... 227 Request Body ....................................................................................................................................... 227 Response Syntax ................................................................................................................................. 229 Response Elements ............................................................................................................................ 230 Errors ..................................................................................................................................................... 230 Examples ............................................................................................................................................... 231 See Also ................................................................................................................................................ 236 Data Types ................................................................................................................................... 237 AggregationConﬁg ................................................................................................................................... 243 Contents ............................................................................................................................................... 243 See Also ................................................................................................................................................ 243 AmplitudeConnectorProﬁleCredentials ............................................................................................... 244 Contents ............................................................................................................................................... 244 See Also ................................................................................................................................................ 244 AmplitudeConnectorProﬁleProperties ................................................................................................. 245 Contents ............................................................................................................................................... 245 See Also ................................................................................................................................................ 245 AmplitudeMetadata ................................................................................................................................. 246 Contents ............................................................................................................................................... 246 See Also ................................................................................................................................................ 246 AmplitudeSourceProperties ................................................................................................................... 247 Contents ............................................................................................................................................... 247 See Also ................................................................................................................................................ 247 ApiKeyCredentials .................................................................................................................................... 248 Contents ............................................................................................................................................... 248 See Also ................................................................................................................................................ 248 AuthenticationConﬁg .............................................................................................................................. 249 Contents ............................................................................................................................................... 249 See Also ................................................................................................................................................ 250 AuthParameter ......................................................................................................................................... 251 Contents ............................................................................................................................................... 251 See Also ................................................................................................................................................ 252 BasicAuthCredentials ............................................................................................................................... 253 Contents ............................................................................................................................................... 253 See Also ................................................................................................................................................ 253 API Version 2020-08-23 ix AmazonAppFlow API Reference ConnectorConﬁguration ......................................................................................................................... 254 Contents ............................................................................................................................................... 254 See Also ................................................................................................................................................ 260 ConnectorDetail ........................................................................................................................................ 261 Contents ............................................................................................................................................... 261 See Also ................................................................................................................................................ 264 ConnectorEntity ........................................................................................................................................ 265 Contents ............................................................................................................................................... 265 See Also ................................................................................................................................................ 266 ConnectorEntityField ............................................................................................................................... 267 Contents ............................................................................................................................................... 267 See Also ................................................................................................................................................ 269 ConnectorMetadata ................................................................................................................................. 270 Contents ............................................................................................................................................... 270 See Also ................................................................................................................................................ 273 ConnectorOAuthRequest ........................................................................................................................ 275 Contents ............................................................................................................................................... 275 See Also ................................................................................................................................................ 275 ConnectorOperator .................................................................................................................................. 276 Contents ............................................................................................................................................... 276 See Also ................................................................................................................................................ 281 ConnectorProﬁle ...................................................................................................................................... 282 Contents ............................................................................................................................................... 282 See Also ................................................................................................................................................ 284 ConnectorProﬁleConﬁg ........................................................................................................................... 285 Contents ............................................................................................................................................... 285 See Also ................................................................................................................................................ 285 ConnectorProﬁleCredentials .................................................................................................................. 286 Contents ............................................................................................................................................... 286 See Also ................................................................................................................................................ 289 ConnectorProﬁleProperties .................................................................................................................... 290 Contents ............................................................................................................................................... 290 See Also ................................................................................................................................................ 293 ConnectorProvisioningConﬁg ................................................................................................................ 294 Contents ............................................................................................................................................... 294 See Also ................................................................................................................................................ 294 API Version 2020-08-23 x AmazonAppFlow API Reference ConnectorRuntimeSetting ...................................................................................................................... 295 Contents ............................................................................................................................................... 295 See Also ................................................................................................................................................ 296 CustomAuthConﬁg ................................................................................................................................... 298 Contents ............................................................................................................................................... 298 See Also ................................................................................................................................................ 298 CustomAuthCredentials .......................................................................................................................... 299 Contents ............................................................................................................................................... 299 See Also ................................................................................................................................................ 299 CustomConnectorDestinationProperties ............................................................................................. 301 Contents ............................................................................................................................................... 301 See Also ................................................................................................................................................ 302 CustomConnectorProﬁleCredentials .................................................................................................... 303 Contents ............................................................................................................................................... 303 See Also ................................................................................................................................................ 304 CustomConnectorProﬁleProperties ...................................................................................................... 305 Contents ............................................................................................................................................... 305 See Also ................................................................................................................................................ 305 CustomConnectorSourceProperties ...................................................................................................... 306 Contents ............................................................................................................................................... 306 See Also ................................................................................................................................................ 307 CustomerProﬁlesDestinationProperties ............................................................................................... 308 Contents ............................................................................................................................................... 308 See Also ................................................................................................................................................ 308 CustomerProﬁlesMetadata ..................................................................................................................... 309 Contents ............................................................................................................................................... 309 See Also ................................................................................................................................................ 309 DatadogConnectorProﬁleCredentials ................................................................................................... 310 Contents ............................................................................................................................................... 310 See Also ................................................................................................................................................ 310 DatadogConnectorProﬁleProperties .................................................................................................... 312 Contents ............................................................................................................................................... 312 See Also ................................................................................................................................................ 312 DatadogMetadata .................................................................................................................................... 313 Contents ............................................................................................................................................... 313 See Also ................................................................................................................................................ 313 API Version 2020-08-23 xi AmazonAppFlow API Reference DatadogSourceProperties ....................................................................................................................... 314 Contents ............................................................................................................................................... 314 See Also ................................................................................................................................................ 314 DataTransferApi ........................................................................................................................................ 315 Contents ............................................................................................................................................... 315 See Also ................................................................................................................................................ 316 DestinationConnectorProperties ........................................................................................................... 317 Contents ............................................................................................................................................... 317 See Also ................................................................................................................................................ 319 DestinationFieldProperties ..................................................................................................................... 320 Contents ............................................................................................................................................... 320 See Also ................................................................................................................................................ 321 DestinationFlowConﬁg ............................................................................................................................ 322 Contents ............................................................................................................................................... 322 See Also ................................................................................................................................................ 323 DynatraceConnectorProﬁleCredentials ................................................................................................ 324 Contents ............................................................................................................................................... 324 See Also ................................................................................................................................................ 324 DynatraceConnectorProﬁleProperties ................................................................................................. 325 Contents ............................................................................................................................................... 325 See Also ................................................................................................................................................ 325 DynatraceMetadata .................................................................................................................................. 326 Contents ............................................................................................................................................... 326 See Also ................................................................................................................................................ 326 DynatraceSourceProperties .................................................................................................................... 327 Contents ............................................................................................................................................... 327 See Also ................................................................................................................................................ 327 ErrorHandlingConﬁg ................................................................................................................................ 328 Contents ............................................................................................................................................... 328 See Also ................................................................................................................................................ 329 ErrorInfo ..................................................................................................................................................... 330 Contents ............................................................................................................................................... 330 See Also ................................................................................................................................................ 330 EventBridgeDestinationProperties ........................................................................................................ 331 Contents ............................................................................................................................................... 331 See Also ................................................................................................................................................ 331 API Version 2020-08-23 xii AmazonAppFlow API Reference EventBridgeMetadata .............................................................................................................................. 332 Contents ............................................................................................................................................... 332 See Also ................................................................................................................................................ 332 ExecutionDetails ....................................................................................................................................... 333 Contents ............................................................................................................................................... 333 See Also ................................................................................................................................................ 333 ExecutionRecord ....................................................................................................................................... 335
amazon-appflow-api-003	amazon-appflow-api.pdf	3	DynatraceConnectorProﬁleCredentials ................................................................................................ 324 Contents ............................................................................................................................................... 324 See Also ................................................................................................................................................ 324 DynatraceConnectorProﬁleProperties ................................................................................................. 325 Contents ............................................................................................................................................... 325 See Also ................................................................................................................................................ 325 DynatraceMetadata .................................................................................................................................. 326 Contents ............................................................................................................................................... 326 See Also ................................................................................................................................................ 326 DynatraceSourceProperties .................................................................................................................... 327 Contents ............................................................................................................................................... 327 See Also ................................................................................................................................................ 327 ErrorHandlingConﬁg ................................................................................................................................ 328 Contents ............................................................................................................................................... 328 See Also ................................................................................................................................................ 329 ErrorInfo ..................................................................................................................................................... 330 Contents ............................................................................................................................................... 330 See Also ................................................................................................................................................ 330 EventBridgeDestinationProperties ........................................................................................................ 331 Contents ............................................................................................................................................... 331 See Also ................................................................................................................................................ 331 API Version 2020-08-23 xii AmazonAppFlow API Reference EventBridgeMetadata .............................................................................................................................. 332 Contents ............................................................................................................................................... 332 See Also ................................................................................................................................................ 332 ExecutionDetails ....................................................................................................................................... 333 Contents ............................................................................................................................................... 333 See Also ................................................................................................................................................ 333 ExecutionRecord ....................................................................................................................................... 335 Contents ............................................................................................................................................... 335 See Also ................................................................................................................................................ 336 ExecutionResult ........................................................................................................................................ 337 Contents ............................................................................................................................................... 337 See Also ................................................................................................................................................ 338 FieldTypeDetails ....................................................................................................................................... 339 Contents ............................................................................................................................................... 339 See Also ................................................................................................................................................ 340 FlowDeﬁnition ........................................................................................................................................... 342 Contents ............................................................................................................................................... 342 See Also ................................................................................................................................................ 345 GlueDataCatalogConﬁg .......................................................................................................................... 347 Contents ............................................................................................................................................... 347 See Also ................................................................................................................................................ 348 GoogleAnalyticsConnectorProﬁleCredentials ..................................................................................... 349 Contents ............................................................................................................................................... 349 See Also ................................................................................................................................................ 350 GoogleAnalyticsConnectorProﬁleProperties ...................................................................................... 351 Contents ............................................................................................................................................... 351 See Also ................................................................................................................................................ 351 GoogleAnalyticsMetadata ...................................................................................................................... 352 Contents ............................................................................................................................................... 352 See Also ................................................................................................................................................ 352 GoogleAnalyticsSourceProperties ......................................................................................................... 353 Contents ............................................................................................................................................... 353 See Also ................................................................................................................................................ 353 HoneycodeConnectorProﬁleCredentials .............................................................................................. 354 Contents ............................................................................................................................................... 354 See Also ................................................................................................................................................ 354 API Version 2020-08-23 xiii AmazonAppFlow API Reference HoneycodeConnectorProﬁleProperties ................................................................................................ 356 Contents ............................................................................................................................................... 356 See Also ................................................................................................................................................ 356 HoneycodeDestinationProperties ......................................................................................................... 357 Contents ............................................................................................................................................... 357 See Also ................................................................................................................................................ 357 HoneycodeMetadata ................................................................................................................................ 358 Contents ............................................................................................................................................... 358 See Also ................................................................................................................................................ 358 IncrementalPullConﬁg ............................................................................................................................. 359 Contents ............................................................................................................................................... 359 See Also ................................................................................................................................................ 359 InforNexusConnectorProﬁleCredentials .............................................................................................. 360 Contents ............................................................................................................................................... 360 See Also ................................................................................................................................................ 361 InforNexusConnectorProﬁleProperties ................................................................................................ 362 Contents ............................................................................................................................................... 362 See Also ................................................................................................................................................ 362 InforNexusMetadata ................................................................................................................................ 363 Contents ............................................................................................................................................... 363 See Also ................................................................................................................................................ 363 InforNexusSourceProperties ................................................................................................................... 364 Contents ............................................................................................................................................... 364 See Also ................................................................................................................................................ 364 LambdaConnectorProvisioningConﬁg .................................................................................................. 365 Contents ............................................................................................................................................... 365 See Also ................................................................................................................................................ 365 LookoutMetricsDestinationProperties .................................................................................................. 366 Contents ............................................................................................................................................... 366 See Also ................................................................................................................................................ 366 MarketoConnectorProﬁleCredentials ................................................................................................... 367 Contents ............................................................................................................................................... 367 See Also ................................................................................................................................................ 368 MarketoConnectorProﬁleProperties ..................................................................................................... 369 Contents ............................................................................................................................................... 369 See Also ................................................................................................................................................ 369 API Version 2020-08-23 xiv AmazonAppFlow API Reference MarketoDestinationProperties ............................................................................................................... 370 Contents ............................................................................................................................................... 370 See Also ................................................................................................................................................ 370 MarketoMetadata ..................................................................................................................................... 371 Contents ............................................................................................................................................... 371 See Also ................................................................................................................................................ 371 MarketoSourceProperties ....................................................................................................................... 372 Contents ............................................................................................................................................... 372 See Also ................................................................................................................................................ 372 MetadataCatalogConﬁg .......................................................................................................................... 373 Contents ............................................................................................................................................... 373 See Also ................................................................................................................................................ 373 MetadataCatalogDetail ........................................................................................................................... 374 Contents ............................................................................................................................................... 374 See Also ................................................................................................................................................ 375 OAuth2Credentials ................................................................................................................................... 376 Contents ............................................................................................................................................... 376 See Also ................................................................................................................................................ 377 OAuth2CustomParameter ...................................................................................................................... 378 Contents ............................................................................................................................................... 378 See Also ................................................................................................................................................ 379 OAuth2Defaults ........................................................................................................................................ 380 Contents ............................................................................................................................................... 380 See Also ................................................................................................................................................ 381 OAuth2Properties .................................................................................................................................... 382 Contents ............................................................................................................................................... 382 See Also ................................................................................................................................................ 383 OAuthCredentials ..................................................................................................................................... 384 Contents ............................................................................................................................................... 384 See Also ................................................................................................................................................ 385 OAuthProperties ....................................................................................................................................... 386 Contents ............................................................................................................................................... 386 See Also ................................................................................................................................................ 387 PardotConnectorProﬁleCredentials ...................................................................................................... 388 Contents ............................................................................................................................................... 388 See Also ................................................................................................................................................ 389 API Version 2020-08-23 xv AmazonAppFlow API Reference PardotConnectorProﬁleProperties ........................................................................................................ 390 Contents ............................................................................................................................................... 390 See Also ................................................................................................................................................ 390 PardotMetadata ........................................................................................................................................ 392 Contents ............................................................................................................................................... 392 See Also ................................................................................................................................................ 392 PardotSourceProperties .......................................................................................................................... 393 Contents ............................................................................................................................................... 393 See Also ................................................................................................................................................ 393 PreﬁxConﬁg ............................................................................................................................................... 394 Contents ............................................................................................................................................... 394 See Also ................................................................................................................................................ 395 PrivateConnectionProvisioningState .................................................................................................... 396 Contents ............................................................................................................................................... 396 See Also ................................................................................................................................................ 396 Range .......................................................................................................................................................... 398 Contents ............................................................................................................................................... 398 See Also ................................................................................................................................................ 398 RedshiftConnectorProﬁleCredentials ................................................................................................... 399 Contents ............................................................................................................................................... 399 See Also ................................................................................................................................................ 399 RedshiftConnectorProﬁleProperties ..................................................................................................... 400 Contents ............................................................................................................................................... 400 See Also ................................................................................................................................................ 402 RedshiftDestinationProperties ............................................................................................................... 403 Contents ............................................................................................................................................... 403 See Also ................................................................................................................................................ 404 RedshiftMetadata ..................................................................................................................................... 405 Contents ............................................................................................................................................... 405 See Also ................................................................................................................................................ 405 RegistrationOutput .................................................................................................................................. 406 Contents ............................................................................................................................................... 406 See Also ................................................................................................................................................ 407 S3DestinationProperties ......................................................................................................................... 408 Contents ............................................................................................................................................... 408 See Also ................................................................................................................................................ 408 API Version 2020-08-23 xvi AmazonAppFlow API Reference S3InputFormatConﬁg .............................................................................................................................. 410 Contents ............................................................................................................................................... 410 See Also ................................................................................................................................................ 410 S3Metadata ............................................................................................................................................... 411 Contents ............................................................................................................................................... 411 See Also ................................................................................................................................................ 411 S3OutputFormatConﬁg .......................................................................................................................... 412 Contents ............................................................................................................................................... 412 See Also ................................................................................................................................................ 413 S3SourceProperties .................................................................................................................................. 414 Contents ............................................................................................................................................... 414 See Also ................................................................................................................................................ 414 SalesforceConnectorProﬁleCredentials ................................................................................................ 416 Contents ............................................................................................................................................... 416 See Also ................................................................................................................................................ 418 SalesforceConnectorProﬁleProperties ................................................................................................. 419 Contents ............................................................................................................................................... 419 See Also ................................................................................................................................................ 420 SalesforceDestinationProperties ........................................................................................................... 421 Contents ............................................................................................................................................... 421 See Also ................................................................................................................................................ 423 SalesforceMetadata ................................................................................................................................. 424 Contents ............................................................................................................................................... 424 See Also ................................................................................................................................................ 425 SalesforceSourceProperties .................................................................................................................... 426 Contents ............................................................................................................................................... 426 See Also ................................................................................................................................................ 427 SAPODataConnectorProﬁleCredentials ............................................................................................... 429 Contents ............................................................................................................................................... 429 See Also ................................................................................................................................................ 429 SAPODataConnectorProﬁleProperties ................................................................................................. 430 Contents ............................................................................................................................................... 430 See Also ................................................................................................................................................ 432 SAPODataDestinationProperties ........................................................................................................... 433 Contents ............................................................................................................................................... 433 See Also ................................................................................................................................................ 434 API Version 2020-08-23 xvii AmazonAppFlow API Reference SAPODataMetadata ................................................................................................................................. 435 Contents ............................................................................................................................................... 435 See Also ................................................................................................................................................ 435 SAPODataPaginationConﬁg ................................................................................................................... 436 Contents ............................................................................................................................................... 436 See Also ................................................................................................................................................ 436 SAPODataParallelismConﬁg .................................................................................................................. 437 Contents ............................................................................................................................................... 437 See Also ................................................................................................................................................ 437 SAPODataSourceProperties ................................................................................................................... 438 Contents ............................................................................................................................................... 438 See Also ................................................................................................................................................ 438 ScheduledTriggerProperties ................................................................................................................... 440 Contents ............................................................................................................................................... 440 See Also ................................................................................................................................................ 442 ServiceNowConnectorProﬁleCredentials ............................................................................................. 443 Contents ............................................................................................................................................... 443 See Also ................................................................................................................................................ 443 ServiceNowConnectorProﬁleProperties ............................................................................................... 445 Contents ............................................................................................................................................... 445 See Also ................................................................................................................................................ 445 ServiceNowMetadata ............................................................................................................................... 446 Contents ............................................................................................................................................... 446 See Also ................................................................................................................................................ 446 ServiceNowSourceProperties ................................................................................................................. 447 Contents ............................................................................................................................................... 447 See Also
amazon-appflow-api-004	amazon-appflow-api.pdf	4	433 See Also ................................................................................................................................................ 434 API Version 2020-08-23 xvii AmazonAppFlow API Reference SAPODataMetadata ................................................................................................................................. 435 Contents ............................................................................................................................................... 435 See Also ................................................................................................................................................ 435 SAPODataPaginationConﬁg ................................................................................................................... 436 Contents ............................................................................................................................................... 436 See Also ................................................................................................................................................ 436 SAPODataParallelismConﬁg .................................................................................................................. 437 Contents ............................................................................................................................................... 437 See Also ................................................................................................................................................ 437 SAPODataSourceProperties ................................................................................................................... 438 Contents ............................................................................................................................................... 438 See Also ................................................................................................................................................ 438 ScheduledTriggerProperties ................................................................................................................... 440 Contents ............................................................................................................................................... 440 See Also ................................................................................................................................................ 442 ServiceNowConnectorProﬁleCredentials ............................................................................................. 443 Contents ............................................................................................................................................... 443 See Also ................................................................................................................................................ 443 ServiceNowConnectorProﬁleProperties ............................................................................................... 445 Contents ............................................................................................................................................... 445 See Also ................................................................................................................................................ 445 ServiceNowMetadata ............................................................................................................................... 446 Contents ............................................................................................................................................... 446 See Also ................................................................................................................................................ 446 ServiceNowSourceProperties ................................................................................................................. 447 Contents ............................................................................................................................................... 447 See Also ................................................................................................................................................ 447 SingularConnectorProﬁleCredentials ................................................................................................... 448 Contents ............................................................................................................................................... 448 See Also ................................................................................................................................................ 448 SingularConnectorProﬁleProperties ..................................................................................................... 449 Contents ............................................................................................................................................... 449 See Also ................................................................................................................................................ 449 SingularMetadata ..................................................................................................................................... 450 Contents ............................................................................................................................................... 450 See Also ................................................................................................................................................ 450 API Version 2020-08-23 xviii AmazonAppFlow API Reference SingularSourceProperties ....................................................................................................................... 451 Contents ............................................................................................................................................... 451 See Also ................................................................................................................................................ 451 SlackConnectorProﬁleCredentials ......................................................................................................... 452 Contents ............................................................................................................................................... 452 See Also ................................................................................................................................................ 453 SlackConnectorProﬁleProperties .......................................................................................................... 454 Contents ............................................................................................................................................... 454 See Also ................................................................................................................................................ 454 SlackMetadata .......................................................................................................................................... 455 Contents ............................................................................................................................................... 455 See Also ................................................................................................................................................ 455 SlackSourceProperties ............................................................................................................................. 456 Contents ............................................................................................................................................... 456 See Also ................................................................................................................................................ 456 SnowﬂakeConnectorProﬁleCredentials ............................................................................................... 457 Contents ............................................................................................................................................... 457 See Also ................................................................................................................................................ 457 SnowﬂakeConnectorProﬁleProperties ................................................................................................. 458 Contents ............................................................................................................................................... 458 See Also ................................................................................................................................................ 460 SnowﬂakeDestinationProperties ........................................................................................................... 461 Contents ............................................................................................................................................... 461 See Also ................................................................................................................................................ 462 SnowﬂakeMetadata ................................................................................................................................. 463 Contents ............................................................................................................................................... 463 See Also ................................................................................................................................................ 463 SourceConnectorProperties ................................................................................................................... 464 Contents ............................................................................................................................................... 464 See Also ................................................................................................................................................ 467 SourceFieldProperties ............................................................................................................................. 468 Contents ............................................................................................................................................... 468 See Also ................................................................................................................................................ 468 SourceFlowConﬁg .................................................................................................................................... 469 Contents ............................................................................................................................................... 469 See Also ................................................................................................................................................ 470 API Version 2020-08-23 xix AmazonAppFlow API Reference SuccessResponseHandlingConﬁg .......................................................................................................... 471 Contents ............................................................................................................................................... 471 See Also ................................................................................................................................................ 471 SupportedFieldTypeDetails .................................................................................................................... 473 Contents ............................................................................................................................................... 473 See Also ................................................................................................................................................ 473 Task ............................................................................................................................................................. 474 Contents ............................................................................................................................................... 474 See Also ................................................................................................................................................ 475 TrendmicroConnectorProﬁleCredentials .............................................................................................. 476 Contents ............................................................................................................................................... 476 See Also ................................................................................................................................................ 476 TrendmicroConnectorProﬁleProperties ............................................................................................... 477 Contents ............................................................................................................................................... 477 See Also ................................................................................................................................................ 477 TrendmicroMetadata ............................................................................................................................... 478 Contents ............................................................................................................................................... 478 See Also ................................................................................................................................................ 478 TrendmicroSourceProperties .................................................................................................................. 479 Contents ............................................................................................................................................... 479 See Also ................................................................................................................................................ 479 TriggerConﬁg ............................................................................................................................................ 480 Contents ............................................................................................................................................... 480 See Also ................................................................................................................................................ 480 TriggerProperties ...................................................................................................................................... 481 Contents ............................................................................................................................................... 481 See Also ................................................................................................................................................ 481 UpsolverDestinationProperties .............................................................................................................. 482 Contents ............................................................................................................................................... 482 See Also ................................................................................................................................................ 482 UpsolverMetadata .................................................................................................................................... 484 Contents ............................................................................................................................................... 484 See Also ................................................................................................................................................ 484 UpsolverS3OutputFormatConﬁg .......................................................................................................... 485 Contents ............................................................................................................................................... 485 See Also ................................................................................................................................................ 485 API Version 2020-08-23 xx AmazonAppFlow API Reference VeevaConnectorProﬁleCredentials ....................................................................................................... 487 Contents ............................................................................................................................................... 487 See Also ................................................................................................................................................ 487 VeevaConnectorProﬁleProperties ......................................................................................................... 488 Contents ............................................................................................................................................... 488 See Also ................................................................................................................................................ 488 VeevaMetadata ......................................................................................................................................... 489 Contents ............................................................................................................................................... 489 See Also ................................................................................................................................................ 489 VeevaSourceProperties ........................................................................................................................... 490 Contents ............................................................................................................................................... 490 See Also ................................................................................................................................................ 491 ZendeskConnectorProﬁleCredentials ................................................................................................... 492 Contents ............................................................................................................................................... 492 See Also ................................................................................................................................................ 493 ZendeskConnectorProﬁleProperties ..................................................................................................... 494 Contents ............................................................................................................................................... 494 See Also ................................................................................................................................................ 494 ZendeskDestinationProperties ............................................................................................................... 495 Contents ............................................................................................................................................... 495 See Also ................................................................................................................................................ 496 ZendeskMetadata ..................................................................................................................................... 497 Contents ............................................................................................................................................... 497 See Also ................................................................................................................................................ 497 ZendeskSourceProperties ....................................................................................................................... 498 Contents ............................................................................................................................................... 498 See Also ................................................................................................................................................ 498 Common Parameters ................................................................................................................... 499 Common Errors ............................................................................................................................ 502 API Version 2020-08-23 xxi AmazonAppFlow Welcome API Reference Welcome to the Amazon AppFlow API reference. This guide is for developers who need detailed information about the Amazon AppFlow API operations, data types, and errors. Amazon AppFlow is a fully managed integration service that enables you to securely transfer data between software as a service (SaaS) applications like Salesforce, Marketo, Slack, and ServiceNow, and Amazon Web Services like Amazon S3 and Amazon Redshift. Use the following links to get started on the Amazon AppFlow API: • Actions: An alphabetical list of all Amazon AppFlow API operations. • Data types: An alphabetical list of all Amazon AppFlow data types. • Common parameters: Parameters that all Query operations can use. • Common errors: Client and server errors that all operations can return. If you're new to Amazon AppFlow, we recommend that you review the Amazon AppFlow User Guide. Amazon AppFlow API users can use vendor-speciﬁc mechanisms for OAuth, and include applicable OAuth attributes (such as auth-code and redirecturi) with the connector- speciﬁc ConnectorProfileProperties when creating a new connector proﬁle using Amazon AppFlow API operations. For example, Salesforce users can refer to the Authorize Apps with OAuth documentation. This document was last published on May 14, 2025. API Version 2020-08-23 1 AmazonAppFlow Actions The following actions are supported: • CancelFlowExecutions • CreateConnectorProﬁle • CreateFlow • DeleteConnectorProﬁle • DeleteFlow • DescribeConnector • DescribeConnectorEntity • DescribeConnectorProﬁles • DescribeConnectors • DescribeFlow • DescribeFlowExecutionRecords • ListConnectorEntities • ListConnectors • ListFlows • ListTagsForResource • RegisterConnector • ResetConnectorMetadataCache • StartFlow • StopFlow • TagResource • UnregisterConnector • UntagResource • UpdateConnectorProﬁle • UpdateConnectorRegistration • UpdateFlow API Reference API Version 2020-08-23 2 AmazonAppFlow API Reference CancelFlowExecutions Cancels active runs for a ﬂow. You can cancel all of the active runs for a ﬂow, or you can cancel speciﬁc runs by providing their IDs. You can cancel a ﬂow run only when
amazon-appflow-api-005	amazon-appflow-api.pdf	5	The following actions are supported: • CancelFlowExecutions • CreateConnectorProﬁle • CreateFlow • DeleteConnectorProﬁle • DeleteFlow • DescribeConnector • DescribeConnectorEntity • DescribeConnectorProﬁles • DescribeConnectors • DescribeFlow • DescribeFlowExecutionRecords • ListConnectorEntities • ListConnectors • ListFlows • ListTagsForResource • RegisterConnector • ResetConnectorMetadataCache • StartFlow • StopFlow • TagResource • UnregisterConnector • UntagResource • UpdateConnectorProﬁle • UpdateConnectorRegistration • UpdateFlow API Reference API Version 2020-08-23 2 AmazonAppFlow API Reference CancelFlowExecutions Cancels active runs for a ﬂow. You can cancel all of the active runs for a ﬂow, or you can cancel speciﬁc runs by providing their IDs. You can cancel a ﬂow run only when the run is in progress. You can't cancel a run that has already completed or failed. You also can't cancel a run that's scheduled to occur but hasn't started yet. To prevent a scheduled run, you can deactivate the ﬂow with the StopFlow action. You cannot resume a run after you cancel it. When you send your request, the status for each run becomes CancelStarted. When the cancellation completes, the status becomes Canceled. Note When you cancel a run, you still incur charges for any data that the run already processed before the cancellation. If the run had already written some data to the ﬂow destination, then that data remains in the destination. If you conﬁgured the ﬂow to use a batch API (such as the Salesforce Bulk API 2.0), then the run will ﬁnish reading or writing its entire batch of data after the cancellation. For these operations, the data processing charges for Amazon AppFlow apply. For the pricing information, see Amazon AppFlow pricing. Request Syntax POST /cancel-flow-executions HTTP/1.1 Content-type: application/json { "executionIds": [ "string" ], "flowName": "string" } URI Request Parameters The request does not use any URI parameters. CancelFlowExecutions API Version 2020-08-23 3 AmazonAppFlow Request Body The request accepts the following data in JSON format. executionIds API Reference The ID of each active run to cancel. These runs must belong to the ﬂow you specify in your request. If you omit this parameter, your request ends all active runs that belong to the ﬂow. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 100 items. Length Constraints: Maximum length of 256. Pattern: \S+ Required: No ﬂowName The name of a ﬂow with active runs that you want to cancel. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "invalidExecutions": [ "string" ] } Request Body API Version 2020-08-23 4 AmazonAppFlow 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. invalidExecutions The IDs of runs that Amazon AppFlow couldn't cancel. These runs might be ineligible for canceling because they haven't started yet or have already completed. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 100 items. Length Constraints: Maximum length of 256. Pattern: \S+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException AppFlow/Requester has invalid or missing permissions. HTTP Status Code: 403 InternalServerException An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ResourceNotFoundException The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not found. HTTP Status Code: 404 ThrottlingException API calls have exceeded the maximum allowed API request rate per account and per Region. Response Elements API Version 2020-08-23 5 AmazonAppFlow HTTP Status Code: 429 ValidationException The request has invalid or missing parameters. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-speciﬁc 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 2020-08-23 6 AmazonAppFlow API Reference CreateConnectorProﬁle Creates a new connector proﬁle associated with your AWS account. There is a soft quota of 100 connector proﬁles per AWS account. If you need more connector proﬁles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel. In each connector proﬁle that you create, you can provide the credentials and properties for only one connector. Request Syntax POST /create-connector-profile HTTP/1.1 Content-type: application/json { "clientToken": "string", "connectionMode": "string", "connectorLabel": "string", "connectorProfileConfig": { "connectorProfileCredentials": { "Amplitude": { "apiKey": "string", "secretKey": "string" }, "CustomConnector": { "apiKey": { "apiKey": "string", "apiSecretKey": "string" }, "authenticationType": "string", "basic": { "password": "string", "username": "string" }, "custom": { "credentialsMap":
amazon-appflow-api-006	amazon-appflow-api.pdf	6	a soft quota of 100 connector proﬁles per AWS account. If you need more connector proﬁles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel. In each connector proﬁle that you create, you can provide the credentials and properties for only one connector. Request Syntax POST /create-connector-profile HTTP/1.1 Content-type: application/json { "clientToken": "string", "connectionMode": "string", "connectorLabel": "string", "connectorProfileConfig": { "connectorProfileCredentials": { "Amplitude": { "apiKey": "string", "secretKey": "string" }, "CustomConnector": { "apiKey": { "apiKey": "string", "apiSecretKey": "string" }, "authenticationType": "string", "basic": { "password": "string", "username": "string" }, "custom": { "credentialsMap": { "string" : "string" }, "customAuthenticationType": "string" }, "oauth2": { "accessToken": "string", "clientId": "string", CreateConnectorProﬁle API Version 2020-08-23 7 AmazonAppFlow API Reference "clientSecret": "string", "oAuthRequest": { "authCode": "string", "redirectUri": "string" }, "refreshToken": "string" } }, "Datadog": { "apiKey": "string", "applicationKey": "string" }, "Dynatrace": { "apiToken": "string" }, "GoogleAnalytics": { "accessToken": "string", "clientId": "string", "clientSecret": "string", "oAuthRequest": { "authCode": "string", "redirectUri": "string" }, "refreshToken": "string" }, "Honeycode": { "accessToken": "string", "oAuthRequest": { "authCode": "string", "redirectUri": "string" }, "refreshToken": "string" }, "InforNexus": { "accessKeyId": "string", "datakey": "string", "secretAccessKey": "string", "userId": "string" }, "Marketo": { "accessToken": "string", "clientId": "string", "clientSecret": "string", "oAuthRequest": { Request Syntax API Version 2020-08-23 8 AmazonAppFlow API Reference "authCode": "string", "redirectUri": "string" } }, "Pardot": { "accessToken": "string", "clientCredentialsArn": "string", "oAuthRequest": { "authCode": "string", "redirectUri": "string" }, "refreshToken": "string" }, "Redshift": { "password": "string", "username": "string" }, "Salesforce": { "accessToken": "string", "clientCredentialsArn": "string", "jwtToken": "string", "oAuth2GrantType": "string", "oAuthRequest": { "authCode": "string", "redirectUri": "string" }, "refreshToken": "string" }, "SAPOData": { "basicAuthCredentials": { "password": "string", "username": "string" }, "oAuthCredentials": { "accessToken": "string", "clientId": "string", "clientSecret": "string", "oAuthRequest": { "authCode": "string", "redirectUri": "string" }, "refreshToken": "string" } }, Request Syntax API Version 2020-08-23 9 AmazonAppFlow API Reference "ServiceNow": { "oAuth2Credentials": { "accessToken": "string", "clientId": "string", "clientSecret": "string", "oAuthRequest": { "authCode": "string", "redirectUri": "string" }, "refreshToken": "string" }, "password": "string", "username": "string" }, "Singular": { "apiKey": "string" }, "Slack": { "accessToken": "string", "clientId": "string", "clientSecret": "string", "oAuthRequest": { "authCode": "string", "redirectUri": "string" } }, "Snowflake": { "password": "string", "username": "string" }, "Trendmicro": { "apiSecretKey": "string" }, "Veeva": { "password": "string", "username": "string" }, "Zendesk": { "accessToken": "string", "clientId": "string", "clientSecret": "string", "oAuthRequest": { "authCode": "string", "redirectUri": "string" Request Syntax API Version 2020-08-23 10 API Reference AmazonAppFlow } } }, "connectorProfileProperties": { "Amplitude": { }, "CustomConnector": { "oAuth2Properties": { "oAuth2GrantType": "string", "tokenUrl": "string", "tokenUrlCustomProperties": { "string" : "string" } }, "profileProperties": { "string" : "string" } }, "Datadog": { "instanceUrl": "string" }, "Dynatrace": { "instanceUrl": "string" }, "GoogleAnalytics": { }, "Honeycode": { }, "InforNexus": { "instanceUrl": "string" }, "Marketo": { "instanceUrl": "string" }, "Pardot": { "businessUnitId": "string", "instanceUrl": "string", "isSandboxEnvironment": boolean }, "Redshift": { "bucketName": "string", "bucketPrefix": "string", "clusterIdentifier": "string", "dataApiRoleArn": "string", Request Syntax API Version 2020-08-23 11 AmazonAppFlow API Reference "databaseName": "string", "databaseUrl": "string", "isRedshiftServerless": boolean, "roleArn": "string", "workgroupName": "string" }, "Salesforce": { "instanceUrl": "string", "isSandboxEnvironment": boolean, "usePrivateLinkForMetadataAndAuthorization": boolean }, "SAPOData": { "applicationHostUrl": "string", "applicationServicePath": "string", "clientNumber": "string", "disableSSO": boolean, "logonLanguage": "string", "oAuthProperties": { "authCodeUrl": "string", "oAuthScopes": [ "string" ], "tokenUrl": "string" }, "portNumber": number, "privateLinkServiceName": "string" }, "ServiceNow": { "instanceUrl": "string" }, "Singular": { }, "Slack": { "instanceUrl": "string" }, "Snowflake": { "accountName": "string", "bucketName": "string", "bucketPrefix": "string", "privateLinkServiceName": "string", "region": "string", "stage": "string", "warehouse": "string" }, "Trendmicro": { }, Request Syntax API Version 2020-08-23 12 AmazonAppFlow API Reference "Veeva": { "instanceUrl": "string" }, "Zendesk": { "instanceUrl": "string" } } }, "connectorProfileName": "string", "connectorType": "string", "kmsArn": "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 clientToken parameter is an idempotency token. It ensures that your CreateConnectorProfile request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value. If you omit a clientToken value, the AWS SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases. If you specify input parameters that diﬀer from your ﬁrst request, an error occurs. If you use a diﬀerent value for clientToken, Amazon AppFlow considers it a new call to CreateConnectorProfile. The token is active for 8 hours. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [ -~]+ URI Request Parameters API Version 2020-08-23 13 AmazonAppFlow Required: No connectionMode API Reference Indicates the connection mode and speciﬁes whether it is public or private. Private ﬂows use AWS PrivateLink to route data over AWS infrastructure without exposing it to the public internet. Type: String Valid Values: Public \| Private Required: Yes connectorLabel The label of the connector. The label is
amazon-appflow-api-007	amazon-appflow-api.pdf	7	If you use a diﬀerent value for clientToken, Amazon AppFlow considers it a new call to CreateConnectorProfile. The token is active for 8 hours. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [ -~]+ URI Request Parameters API Version 2020-08-23 13 AmazonAppFlow Required: No connectionMode API Reference Indicates the connection mode and speciﬁes whether it is public or private. Private ﬂows use AWS PrivateLink to route data over AWS infrastructure without exposing it to the public internet. Type: String Valid Values: Public \| Private Required: Yes connectorLabel The label of the connector. The label is unique for each ConnectorRegistration in your AWS account. Only needed if calling for CUSTOMCONNECTOR connector type/. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ Required: No connectorProﬁleConﬁg Deﬁnes the connector-speciﬁc conﬁguration and credentials. Type: ConnectorProﬁleConﬁg object Required: Yes connectorProﬁleName The name of the connector proﬁle. The name is unique for each ConnectorProfile in your AWS account. Type: String Length Constraints: Maximum length of 256. Request Body API Version 2020-08-23 14 AmazonAppFlow Pattern: [\w/!@#+=.-]+ Required: Yes connectorType API Reference The type of connector, such as Salesforce, Amplitude, and so on. Type: String Valid Values: Salesforce \| Singular \| Slack \| Redshift \| S3 \| Marketo \| Googleanalytics \| Zendesk \| Servicenow \| Datadog \| Trendmicro \| Snowflake \| Dynatrace \| Infornexus \| Amplitude \| Veeva \| EventBridge \| LookoutMetrics \| Upsolver \| Honeycode \| CustomerProfiles \| SAPOData \| CustomConnector \| Pardot Required: Yes kmsArn 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 Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:aws:kms:.:[0-9]+:. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "connectorProfileArn": "string" } Response Syntax API Version 2020-08-23 15 AmazonAppFlow 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. connectorProﬁleArn The Amazon Resource Name (ARN) of the connector proﬁle. Type: String Length Constraints: Maximum length of 512. Pattern: arn:aws:appflow:.:[0-9]+:. Errors For information about the errors that are common to all actions, see Common Errors. ConﬂictException There was a conﬂict when processing the request (for example, a ﬂow with the given name already exists within the account. Check for conﬂicting resource names and try again. HTTP Status Code: 409 ConnectorAuthenticationException An error occurred when authenticating with the connector endpoint. HTTP Status Code: 401 InternalServerException An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ServiceQuotaExceededException The request would cause a service quota (such as the number of ﬂows) to be exceeded. HTTP Status Code: 402 Response Elements API Version 2020-08-23 16 API Reference AmazonAppFlow ValidationException The request has invalid or missing parameters. HTTP Status Code: 400 Examples CustomConnector This example shows a sample request for the CreateConnectorProfile API (without OAuth) and a sample response. Sample Request { "connectorProfileName": "Connector_Profile_Name_Value", "kmsArn": null, "connectorType": "CUSTOMCONNECTOR", "connectorLabel": "MyCustomConnector", "connectionMode": "Public", "connectorProfileConfig": { "connectorProfileProperties": { "salesforce": { "instanceUrl": "InstanceUrl_value", "isSandboxEnvironment": false } }, "connectorProfileCredentials": { "salesforce": { "accessToken": "<AccessToken>", "refreshToken": "<RefreshToken>", "oauthRequest": { "authCode": null, "redirectUri": null } Examples API Version 2020-08-23 17 AmazonAppFlow } } } } Sample Response { API Reference "connectorProfileArn": "arn:aws:appflow:region:<AccountId>:connectorprofile/ Connector_Profile_Name" } Salesforce without OAuth This example shows a sample request for the CreateConnectorProfile API (without OAuth) and a sample response. Sample Request { "connectorProfileName": "Connector_Profile_Name_Value", "kmsArn": null, "connectorType": "Salesforce", "connectorLabel": "Salesforce", "connectionMode": "Public", "connectorProfileConfig": { "connectorProfileProperties": { "salesforce": { "instanceUrl": "InstanceUrl_value", "isSandboxEnvironment": false } }, "connectorProfileCredentials": { "salesforce": { "accessToken": "<AccessToken>", "refreshToken": "<RefreshToken>", "oauthRequest": { "authCode": null, "redirectUri": null } } } Examples API Version 2020-08-23 18 API Reference AmazonAppFlow } } Sample Response { "connectorProfileArn": "arn:aws:appflow:region:<AccountId>:connectorprofile/ Connector_Profile_Name" } Salesforce with OAuth These examples show a request with OAuth and a sample response. Sample Request { "connectorProfileName": "connector-profile-name_value", "kmsArn": null, "connectorType": "Salesforce", "connectionMode": "Public", "connectorProfileConfig": { "connectorProfileProperties": { "salesforce": { "isSandboxEnvironment": false } }, "connectorProfileCredentials": { "salesforce": { "oauthRequest": { "authCode": "<AuthCode>", "redirectUri": "redirectUri" } } } } } Sample Response { Examples API Version 2020-08-23 19 AmazonAppFlow API Reference "connectorProfileArn": "arn:aws:appflow:region:<AccountId>:connectorprofile/ connector-profile-name" } Zendesk This example shows a sample request and response for the CreateConnectorProfile API using Zendesk. Sample Request { "connectorProfileName": "connector-profile-name", "connectorType": "Zendesk", "connectionMode": "Public", "connectorProfileConfig": { "connectorProfileProperties": { "zendesk": { "instanceUrl": "Zendesk_Url" } }, "connectorProfileCredentials": { "zendesk": { "clientId": "aws_integration_to_zendesk", "clientSecret": "<ClientSecret>", "accessToken": "<AccessToken>", "oauthRequest": { "authCode": null, "redirectUri": null } } } } } Sample Response { "connectorProfileArn": "arn:aws:appflow:region:<AccountId>:connectorprofile/ connector-profile-name" } Examples API Version 2020-08-23 20 AmazonAppFlow Google Analytics API Reference This example shows a sample request and response for the CreateConnectorProfile API using
amazon-appflow-api-008	amazon-appflow-api.pdf	8	Sample Response { Examples API Version 2020-08-23 19 AmazonAppFlow API Reference "connectorProfileArn": "arn:aws:appflow:region:<AccountId>:connectorprofile/ connector-profile-name" } Zendesk This example shows a sample request and response for the CreateConnectorProfile API using Zendesk. Sample Request { "connectorProfileName": "connector-profile-name", "connectorType": "Zendesk", "connectionMode": "Public", "connectorProfileConfig": { "connectorProfileProperties": { "zendesk": { "instanceUrl": "Zendesk_Url" } }, "connectorProfileCredentials": { "zendesk": { "clientId": "aws_integration_to_zendesk", "clientSecret": "<ClientSecret>", "accessToken": "<AccessToken>", "oauthRequest": { "authCode": null, "redirectUri": null } } } } } Sample Response { "connectorProfileArn": "arn:aws:appflow:region:<AccountId>:connectorprofile/ connector-profile-name" } Examples API Version 2020-08-23 20 AmazonAppFlow Google Analytics API Reference This example shows a sample request and response for the CreateConnectorProfile API using Google Analytics. Sample Request { "connectorProfileName": "connector-profile-name", "connectorType": "Googleanalytics", "connectionMode": "Public", "connectorProfileConfig": { "connectorProfileProperties": { "googleAnalytics": {} }, "connectorProfileCredentials": { "googleAnalytics": { "clientId": "<ClientId>", "clientSecret": "<ClientSecret>", "accessToken": "<AccessToken>", "refreshToken": "<RefreshToken>", "oauthRequest": { "authCode": null, "redirectUri": null } } } } } { "connectorProfileArn": "arn:aws:appflow:region:<AccountId>:connectorprofile/ connector-profile-name" } Marketo This example shows a sample request and response for the CreateConnectorProfile API using Marketo. Examples API Version 2020-08-23 21 API Reference AmazonAppFlow Sample Request { "connectorProfileName": "Connector-profile-new", "connectorType": "Marketo", "connectionMode": "Public", "connectorProfileConfig": { "connectorProfileProperties": { "marketo": { "instanceUrl": "Marketo_Url" } }, "connectorProfileCredentials": { "marketo": { "clientId": "<ClientId>>", "clientSecret": "<ClientSecret>", "accessToken": "<AccessToken>", "oauthRequest": { "authCode": null, "redirectUri": null } } } } } Sample Response { "connectorProfileArn": "arn:aws:appflow:region:<AccountId>:connectorprofile/ Connector-profile-new" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See Also API Version 2020-08-23 22 AmazonAppFlow • 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 2020-08-23 23 AmazonAppFlow CreateFlow API Reference Enables your application to create a new ﬂow using Amazon AppFlow. You must create a connector proﬁle before calling this API. Please note that the Request Syntax below shows syntax for multiple destinations, however, you can only transfer data to one item in this list at a time. Amazon AppFlow does not currently support ﬂows to multiple destinations at once. Request Syntax POST /create-flow HTTP/1.1 Content-type: application/json { "clientToken": "string", "description": "string", "destinationFlowConfigList": [ { "apiVersion": "string", "connectorProfileName": "string", "connectorType": "string", "destinationConnectorProperties": { "CustomConnector": { "customProperties": { "string" : "string" }, "entityName": "string", "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "idFieldNames": [ "string" ], "writeOperationType": "string" }, "CustomerProfiles": { "domainName": "string", "objectTypeName": "string" }, "EventBridge": { "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", CreateFlow API Version 2020-08-23 24 AmazonAppFlow API Reference "failOnFirstDestinationError": boolean }, "object": "string" }, "Honeycode": { "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "object": "string" }, "LookoutMetrics": { }, "Marketo": { "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "object": "string" }, "Redshift": { "bucketPrefix": "string", "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "intermediateBucketName": "string", "object": "string" }, "S3": { "bucketName": "string", "bucketPrefix": "string", "s3OutputFormatConfig": { "aggregationConfig": { "aggregationType": "string", "targetFileSize": number }, "fileType": "string", "prefixConfig": { "pathPrefixHierarchy": [ "string" ], "prefixFormat": "string", Request Syntax API Version 2020-08-23 25 AmazonAppFlow API Reference "prefixType": "string" }, "preserveSourceDataTyping": boolean } }, "Salesforce": { "dataTransferApi": "string", "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "idFieldNames": [ "string" ], "object": "string", "writeOperationType": "string" }, "SAPOData": { "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "idFieldNames": [ "string" ], "objectPath": "string", "successResponseHandlingConfig": { "bucketName": "string", "bucketPrefix": "string" }, "writeOperationType": "string" }, "Snowflake": { "bucketPrefix": "string", "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "intermediateBucketName": "string", "object": "string" }, "Upsolver": { "bucketName": "string", "bucketPrefix": "string", "s3OutputFormatConfig": { Request Syntax API Version 2020-08-23 26 AmazonAppFlow API Reference "aggregationConfig": { "aggregationType": "string", "targetFileSize": number }, "fileType": "string", "prefixConfig": { "pathPrefixHierarchy": [ "string" ], "prefixFormat": "string", "prefixType": "string" } } }, "Zendesk": { "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "idFieldNames": [ "string" ], "object": "string", "writeOperationType": "string" } } } ], "flowName": "string", "kmsArn": "string", "metadataCatalogConfig": { "glueDataCatalog": { "databaseName": "string", "roleArn": "string", "tablePrefix": "string" } }, "sourceFlowConfig": { "apiVersion": "string", "connectorProfileName": "string", "connectorType": "string", "incrementalPullConfig": { "datetimeTypeFieldName": "string" }, "sourceConnectorProperties": { "Amplitude": { "object": "string" Request Syntax API Version 2020-08-23 27 API Reference AmazonAppFlow }, "CustomConnector": { "customProperties": { "string" : "string" }, "dataTransferApi": { "Name": "string", "Type": "string" }, "entityName": "string" }, "Datadog": { "object": "string" }, "Dynatrace": { "object": "string" }, "GoogleAnalytics": { "object": "string" }, "InforNexus": { "object": "string" }, "Marketo": { "object": "string" }, "Pardot": { "object": "string" }, "S3": { "bucketName": "string", "bucketPrefix": "string", "s3InputFormatConfig": { "s3InputFileType": "string" } }, "Salesforce": { "dataTransferApi": "string", "enableDynamicFieldUpdate": boolean, "includeDeletedRecords": boolean, "object": "string" }, "SAPOData": { "objectPath": "string", Request Syntax API Version 2020-08-23 28 AmazonAppFlow API Reference "paginationConfig": { "maxPageSize": number },
amazon-appflow-api-009	amazon-appflow-api.pdf	9	"string" Request Syntax API Version 2020-08-23 27 API Reference AmazonAppFlow }, "CustomConnector": { "customProperties": { "string" : "string" }, "dataTransferApi": { "Name": "string", "Type": "string" }, "entityName": "string" }, "Datadog": { "object": "string" }, "Dynatrace": { "object": "string" }, "GoogleAnalytics": { "object": "string" }, "InforNexus": { "object": "string" }, "Marketo": { "object": "string" }, "Pardot": { "object": "string" }, "S3": { "bucketName": "string", "bucketPrefix": "string", "s3InputFormatConfig": { "s3InputFileType": "string" } }, "Salesforce": { "dataTransferApi": "string", "enableDynamicFieldUpdate": boolean, "includeDeletedRecords": boolean, "object": "string" }, "SAPOData": { "objectPath": "string", Request Syntax API Version 2020-08-23 28 AmazonAppFlow API Reference "paginationConfig": { "maxPageSize": number }, "parallelismConfig": { "maxParallelism": number } }, "ServiceNow": { "object": "string" }, "Singular": { "object": "string" }, "Slack": { "object": "string" }, "Trendmicro": { "object": "string" }, "Veeva": { "documentType": "string", "includeAllVersions": boolean, "includeRenditions": boolean, "includeSourceFiles": boolean, "object": "string" }, "Zendesk": { "object": "string" } } }, "tags": { "string" : "string" }, "tasks": [ { "connectorOperator": { "Amplitude": "string", "CustomConnector": "string", "Datadog": "string", "Dynatrace": "string", "GoogleAnalytics": "string", "InforNexus": "string", "Marketo": "string", Request Syntax API Version 2020-08-23 29 AmazonAppFlow API Reference "Pardot": "string", "S3": "string", "Salesforce": "string", "SAPOData": "string", "ServiceNow": "string", "Singular": "string", "Slack": "string", "Trendmicro": "string", "Veeva": "string", "Zendesk": "string" }, "destinationField": "string", "sourceFields": [ "string" ], "taskProperties": { "string" : "string" }, "taskType": "string" } ], "triggerConfig": { "triggerProperties": { "Scheduled": { "dataPullMode": "string", "firstExecutionFrom": number, "flowErrorDeactivationThreshold": number, "scheduleEndTime": number, "scheduleExpression": "string", "scheduleOffset": number, "scheduleStartTime": number, "timezone": "string" } }, "triggerType": "string" } } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. URI Request Parameters API Version 2020-08-23 30 AmazonAppFlow clientToken API Reference The clientToken parameter is an idempotency token. It ensures that your CreateFlow request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value. If you omit a clientToken value, the AWS SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases. If you specify input parameters that diﬀer from your ﬁrst request, an error occurs. If you use a diﬀerent value for clientToken, Amazon AppFlow considers it a new call to CreateFlow. The token is active for 8 hours. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [ -~]+ Required: No description A description of the ﬂow you want to create. Type: String Length Constraints: Maximum length of 2048. Pattern: [\w!@#\-.?,\s]* Required: No destinationFlowConﬁgList The conﬁguration that controls how Amazon AppFlow places data in the destination connector. Type: Array of DestinationFlowConﬁg objects Required: Yes ﬂowName The speciﬁed name of the ﬂow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. Request Body API Version 2020-08-23 31 AmazonAppFlow Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ Required: Yes kmsArn API Reference 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 Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:aws:kms:.:[0-9]+:. Required: No metadataCatalogConﬁg Speciﬁes the conﬁguration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated ﬂow. When Amazon AppFlow catalogs the data from a ﬂow, it stores metadata in a data catalog. Type: MetadataCatalogConﬁg object Required: No sourceFlowConﬁg The conﬁguration that controls how Amazon AppFlow retrieves data from the source connector. Type: SourceFlowConﬁg object Required: Yes tags The tags used to organize, track, or control access for your ﬂow. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Request Body API Version 2020-08-23 32 AmazonAppFlow API Reference Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Maximum length of 256. Value Pattern: [\s\w+-=\.:/@]* Required: No tasks A list of tasks that Amazon AppFlow performs while transferring the data in the ﬂow run. Type: Array of Task objects Required: Yes triggerConﬁg The trigger settings that determine how and when the ﬂow runs. Type: TriggerConﬁg object Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "flowArn": "string", "flowStatus": "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. ﬂowArn The ﬂow's Amazon Resource Name (ARN). Response Syntax API Version 2020-08-23 33 AmazonAppFlow Type: String Length Constraints: Maximum length of 512. Pattern: arn:aws:appflow:.:[0-9]+:. ﬂowStatus Indicates the current status of the ﬂow. Type:
amazon-appflow-api-010	amazon-appflow-api.pdf	10	data in the ﬂow run. Type: Array of Task objects Required: Yes triggerConﬁg The trigger settings that determine how and when the ﬂow runs. Type: TriggerConﬁg object Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "flowArn": "string", "flowStatus": "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. ﬂowArn The ﬂow's Amazon Resource Name (ARN). Response Syntax API Version 2020-08-23 33 AmazonAppFlow Type: String Length Constraints: Maximum length of 512. Pattern: arn:aws:appflow:.:[0-9]+:. ﬂowStatus Indicates the current status of the ﬂow. Type: String API Reference Valid Values: Active \| Deprecated \| Deleted \| Draft \| Errored \| Suspended Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException AppFlow/Requester has invalid or missing permissions. HTTP Status Code: 403 ConﬂictException There was a conﬂict when processing the request (for example, a ﬂow with the given name already exists within the account. Check for conﬂicting resource names and try again. HTTP Status Code: 409 ConnectorAuthenticationException An error occurred when authenticating with the connector endpoint. HTTP Status Code: 401 ConnectorServerException An error occurred when retrieving data from the connector endpoint. HTTP Status Code: 400 InternalServerException An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 Errors API Version 2020-08-23 34 AmazonAppFlow ResourceNotFoundException API Reference The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not found. HTTP Status Code: 404 ServiceQuotaExceededException The request would cause a service quota (such as the number of ﬂows) to be exceeded. HTTP Status Code: 402 ValidationException The request has invalid or missing parameters. HTTP Status Code: 400 Examples Salesforce This example shows a sample request for the CreateFlow API using Salesforce. If you see the error shown in the second sample, it is because of an expired access or refresh token. Retrieve a new access or refresh token to proceed. Sample Request { "flowName": "testFlowSaleforce", "description": "TestFlow", "triggerConfig": { "triggerType": "Scheduled", "triggerProperties": { "scheduledTriggerProperties" : { "scheduleExpression" : "rate(1minutes)" } } }, "sourceFlowConfig": { "connectorType": "Salesforce", "connectorLabel":"MyCustomConnector", "connectorProfileName": "Connector_Profile_Name", Examples API Version 2020-08-23 35 AmazonAppFlow API Reference "sourceConnectorProperties": { "salesforce": { "object": "account" } } }, "destinationFlowConfigList": [ { "connectorType": "S3", "connectorLabel":"MyCustomConnector", "destinationConnectorProperties": { "s3": { "bucketName": "BucketName", "bucketKey": "BucketKey" } } } ], "tasks": [ { "sourceFields": [ "CreatedDate" ], "taskProperties": { }, "destinationField": "CreatedDate", "taskType": "Map" }, { "destinationField": "LastActivityDate", "sourceFields": [ "LastActivityDate" ], "taskProperties": { }, "taskType": "Map" } ] } { Examples API Version 2020-08-23 36 AmazonAppFlow API Reference "message": "Error while authenticating to connector" } Zendesk This example shows a sample request for the CreateFlow API using Zendesk. Sample Request { "useDefaultEncryption": false, "flowName": "testFlowZendesk", "description": "TestFlow", "triggerConfig": { "triggerType": "Scheduled", "triggerProperties": { "scheduledTriggerProperties" : { "scheduleExpression" : "rate(1minutes)" } } }, "sourceFlowConfig": { "connectorType": "Zendesk", "connectorProfileName": "connector-profile-name", "sourceConnectorProperties": { "zendesk": { "object": "tickets" } } }, "destinationFlowConfigList": [ { "connectorType": "S3", "connectorProfileName": "Test", "destinationConnectorProperties": { "s3": { "bucketName": "BucketName", "bucketKey": "BucketKey" } } } ], "tasks": [ Examples API Version 2020-08-23 37 API Reference AmazonAppFlow { "destinationField": "url", "sourceFields": [ "url" ], "taskProperties": { "SOURCE_DATA_TYPE": "integer" }, "taskType": "Map" } ] } Google Analytics This example shows a sample request for the CreateFlow API using Google Analytics. Sample Request { "useDefaultEncryption": false, "flowName": "testFlowGAnalytics", "description": "TestFlow", "triggerConfig": { "triggerType": "Scheduled", "triggerProperties": { "scheduledTriggerProperties" : { "scheduleExpression" : "rate(1minutes)" } } }, "sourceFlowConfig": { "connectorType": "Googleanalytics", "connectorProfileName": "connector-profile-name", "sourceConnectorProperties": { "googleanalytics": { "object": "ObjectID" } } }, "destinationFlowConfigList": [ { "connectorType": "S3", Examples API Version 2020-08-23 38 AmazonAppFlow API Reference "connectorProfileName": "Test", "destinationConnectorProperties": { "s3": { "bucketName": "BucketName", "bucketKey": "BucketKey" } } } ], "tasks": [ { "destinationField": "url", "sourceFields": [ "url" ], "taskProperties": { "SOURCE_DATA_TYPE": "integer" }, "taskType": "Map" } ] } Marketo This example shows a sample request for the CreateFlow API using Marketo. Sample Request { "flowName": "testMarketo", "description": "TestFlow", "triggerConfig": { "triggerType": "Scheduled", "triggerProperties": { "scheduledTriggerProperties" : { "scheduleExpression" : "rate(1minutes)" } } }, "sourceFlowConfig": { "connectorType": "Marketo", "connectorProfileName": "Connector-profile-new", Examples API Version 2020-08-23 39 AmazonAppFlow API Reference "sourceConnectorProperties": { "marketo": { "object": "leads" } } }, "destinationFlowConfigList": [ { "connectorType": "S3", "connectorProfileName": "Test", "destinationConnectorProperties": { "s3": { "bucketName": "BucketName", "bucketKey": "BucketKey" } } } ], "tasks": [ { "connectorOperator": { "marketo":"BETWEEN" }, "sourceFields": [ "updatedAt" ], "taskProperties": { "DATA_TYPE": "datetime", "LOWER_BOUND": "Lower_Bound_value", "UPPER_BOUND": "Upper_Bound_value" }, "taskType": "Filter" }, { "destinationField": "company", "sourceFields": [ "company" ], "taskProperties": { "SOURCE_DATA_TYPE": "string" }, "taskType": "Map" } ] Examples API Version 2020-08-23 40 AmazonAppFlow } Connection credentials API Reference This Java example shows credentials associated with a connection. In this case, the example uses OAuth. These credentials are stored in secrets manager after the proﬁle is created. ConnectorProfileCredentials credentials = new ConnectorProfileCredentials().withSalesforce( new SalesforceConnectorProfileCredentials().withAccessToken(accessToken)
amazon-appflow-api-011	amazon-appflow-api.pdf	11	"S3", "connectorProfileName": "Test", "destinationConnectorProperties": { "s3": { "bucketName": "BucketName", "bucketKey": "BucketKey" } } } ], "tasks": [ { "connectorOperator": { "marketo":"BETWEEN" }, "sourceFields": [ "updatedAt" ], "taskProperties": { "DATA_TYPE": "datetime", "LOWER_BOUND": "Lower_Bound_value", "UPPER_BOUND": "Upper_Bound_value" }, "taskType": "Filter" }, { "destinationField": "company", "sourceFields": [ "company" ], "taskProperties": { "SOURCE_DATA_TYPE": "string" }, "taskType": "Map" } ] Examples API Version 2020-08-23 40 AmazonAppFlow } Connection credentials API Reference This Java example shows credentials associated with a connection. In this case, the example uses OAuth. These credentials are stored in secrets manager after the proﬁle is created. ConnectorProfileCredentials credentials = new ConnectorProfileCredentials().withSalesforce( new SalesforceConnectorProfileCredentials().withAccessToken(accessToken) .withRefreshToken(refreshToken)); Connection properties This Java example shows other properties associated with a connection to Salesforce. ConnectorProfileProperties properties = new ConnectorProfileProperties().withSalesforce( new SalesforceConnectorProfileProperties().withInstanceUrl(instanceUrl)); Connector proﬁle creation To create a ﬂow, you must ﬁrst create a connector proﬁle. This Java example shows information about connecting to Salesforce. amazonAppflow.createConnectorProfile(new CreateConnectorProfileRequest().withConnectorProfileConfig( new ConnectorProfileConfig().withConnectorProfileCredentials(credentials) .withConnectorProfileProperties(properties)) .withConnectorProfileName(salesforceProfileName) .withConnectorType(ConnectorType.Salesforce) .withConnectionMode(ConnectionMode.Public)); Source connection properties This Java example shows properties for a source connection. Account is the object in Salesforce that we want to retrieve. You can ﬁnd a list of all supported objects by using the Examples API Version 2020-08-23 41 AmazonAppFlow API Reference listConnectorEntity API. The ConnectorProfileName is the connector proﬁle, the creation of which is seen in the previous example. SourceFlowConfig sourceFlowConfig = new SourceFlowConfig().withSourceConnectorProperties( new SourceConnectorProperties().withSalesforce(new SalesforceSourceProperties().withObject("Account"))) .withConnectorType(ConnectorType.Salesforce) .withConnectorProfileName(salesforceProfileName); Destination connection properties This Java example shows properties for a destination connection. Note that many AWS connectors such as Amazon S3 don't require a connector proﬁle. Amazon AppFlow accesses S3 buckets through a bucket resource policy, therefore a connector proﬁle isn't needed. DestinationFlowConfig destinationFlowConfig = new DestinationFlowConfig().withConnectorType(ConnectorType.S3) .withDestinationConnectorProperties(new DestinationConnectorProperties().withS3( new S3DestinationProperties().withBucketName(bucketName).withBucketPrefix("testPrefix"))); Tasks Tasks describe what to do with the data once it has been retrieved, but before it is sent to the destination. Most connectors require a projection task. A projection task describes what ﬁelds should be retrieved from the source object. Fields that can be retrieved can be discovered by making a call to the DescribeConnectorEntity API. Task projectionTask = new Task().withTaskType(TaskType.Filter) .withConnectorOperator(new ConnectorOperator().withSalesforce(SalesforceConnectorOperator.PROJECTION)) .withSourceFields("Id", "Name"); Mapping task Most ﬂows also require at least one mapping task. Mapping tasks map a source ﬁeld to a destination ﬁeld. This Java example shows the mapping between the retrieved ﬁeld, Id, to a new ﬁeld, AccountId. Examples API Version 2020-08-23 42 AmazonAppFlow API Reference Task createdMappingTask = new Task().withTaskType(TaskType.Map) .withConnectorOperator(new ConnectorOperator().withSalesforce(SalesforceConnectorOperator.NO_OP)) .withSourceFields("Id") .withDestinationField("AccountId"); amazonAppflow.createFlow(new CreateFlowRequest().withFlowName(salesforceFlowName) .withTriggerConfig(new TriggerConfig().withTriggerType(TriggerType.OnDemand)) .withSourceFlowConfig(sourceFlowConfig) .withDestinationFlowConfigList(destinationFlowConfig) .withTasks(projectionTask, idMappingTask, createdMappingTask)); Sample imports This Java example shows sample imports. import com.amazonaws.services.appflow.AmazonAppflow; import com.amazonaws.services.appflow.model.ConnectionMode; import com.amazonaws.services.appflow.model.ConnectorOperator; import com.amazonaws.services.appflow.model.ConnectorProfileConfig; import com.amazonaws.services.appflow.model.ConnectorProfileCredentials; import com.amazonaws.services.appflow.model.ConnectorProfileProperties; import com.amazonaws.services.appflow.model.ConnectorType; import com.amazonaws.services.appflow.model.CreateConnectorProfileRequest; import com.amazonaws.services.appflow.model.CreateFlowRequest; import com.amazonaws.services.appflow.model.DeleteConnectorProfileRequest; import com.amazonaws.services.appflow.model.DeleteFlowRequest; import com.amazonaws.services.appflow.model.DestinationConnectorProperties; import com.amazonaws.services.appflow.model.DestinationFlowConfig; import com.amazonaws.services.appflow.model.S3DestinationProperties; import com.amazonaws.services.appflow.model.SalesforceConnectorOperator; import com.amazonaws.services.appflow.model.SalesforceConnectorProfileCredentials; import com.amazonaws.services.appflow.model.SalesforceConnectorProfileProperties; import com.amazonaws.services.appflow.model.SalesforceSourceProperties; import com.amazonaws.services.appflow.model.SourceConnectorProperties; import com.amazonaws.services.appflow.model.SourceFlowConfig; import com.amazonaws.services.appflow.model.Task; import com.amazonaws.services.appflow.model.TaskType; import com.amazonaws.services.appflow.model.TriggerConfig; import com.amazonaws.services.appflow.model.TriggerType; Examples API Version 2020-08-23 43 AmazonAppFlow See Also API Reference For more information about using this API in one of the language-speciﬁc 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 2020-08-23 44 AmazonAppFlow API Reference DeleteConnectorProﬁle Enables you to delete an existing connector proﬁle. Request Syntax POST /delete-connector-profile HTTP/1.1 Content-type: application/json { "connectorProfileName": "string", "forceDelete": boolean } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. connectorProﬁleName The name of the connector proﬁle. The name is unique for each ConnectorProfile in your account. Type: String Length Constraints: Maximum length of 256. Pattern: [\w/!@#+=.-]+ Required: Yes forceDelete Indicates whether Amazon AppFlow should delete the proﬁle, even if it is currently in use in one or more ﬂows. Type: Boolean DeleteConnectorProﬁle API Version 2020-08-23 45 AmazonAppFlow Required: No Response Syntax HTTP/1.1 200 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. ConﬂictException There was a conﬂict when processing the request (for example, a ﬂow with the given name already exists within the account. Check for conﬂicting resource names and try again. HTTP Status Code: 409 InternalServerException An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ResourceNotFoundException The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not found. HTTP Status Code: 404 Examples Marketo This example shows a sample request and response for the CreateConnectorProfile API using Marketo. If forceDelete is false, and there are ﬂows associated, you will see a
amazon-appflow-api-012	amazon-appflow-api.pdf	12	conﬂict when processing the request (for example, a ﬂow with the given name already exists within the account. Check for conﬂicting resource names and try again. HTTP Status Code: 409 InternalServerException An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ResourceNotFoundException The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not found. HTTP Status Code: 404 Examples Marketo This example shows a sample request and response for the CreateConnectorProfile API using Marketo. If forceDelete is false, and there are ﬂows associated, you will see a message similar to that shown in the third sample. Response Syntax API Version 2020-08-23 46 AmazonAppFlow Sample Request { "connectorProfileName": "testMarketoProfile", "forceDelete": "true" API Reference } Sample Response { "deleted": true, "flowNames": null } { "message": "Conflict executing request: Connector profile: testMarketoProfile is associated with one or more flows. If you still want to delete it, then make delete request with forceDelete flag as true. Some of the associated flows are: [myTestFlow1]" } See Also For more information about using this API in one of the language-speciﬁc 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 2020-08-23 47 AmazonAppFlow API Reference See Also API Version 2020-08-23 48 AmazonAppFlow DeleteFlow API Reference Enables your application to delete an existing ﬂow. Before deleting the ﬂow, Amazon AppFlow validates the request by checking the ﬂow conﬁguration and status. You can delete ﬂows one at a time. Request Syntax POST /delete-flow HTTP/1.1 Content-type: application/json { "flowName": "string", "forceDelete": boolean } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. ﬂowName The speciﬁed name of the ﬂow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ Required: Yes forceDelete Indicates whether Amazon AppFlow should delete the ﬂow, even if it is currently in use. Type: Boolean DeleteFlow API Version 2020-08-23 49 AmazonAppFlow Required: No Response Syntax HTTP/1.1 200 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. ConﬂictException There was a conﬂict when processing the request (for example, a ﬂow with the given name already exists within the account. Check for conﬂicting resource names and try again. HTTP Status Code: 409 InternalServerException An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ResourceNotFoundException The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not found. HTTP Status Code: 404 Examples An active scheduled ﬂow with forceDelete false This example shows an active scheduled ﬂow with forceDelete false. The result is that a conﬂict exception is thrown. Response Syntax API Version 2020-08-23 50 API Reference AmazonAppFlow Sample Request { "flowName": "flowName_value" } Sample Response { "message": "Conflict executing request: Flow is in active state, please set forceDelete to true or deactivate the flow: flowName_value" } An active scheduled ﬂow with forceDelete true This example shows an active scheduled ﬂow with forceDelete true. The result is that the ﬂow is deleted successfully. Sample Request { "flowName": "flowName_value", "forceDelete": true } Sample Response {} See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2020-08-23 51 AmazonAppFlow • 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 2020-08-23 52 AmazonAppFlow DescribeConnector API Reference Describes the given custom connector registered in your AWS account. This API can be used for custom connectors that are registered in your account and also for Amazon authored connectors. Request Syntax POST /describe-connector HTTP/1.1 Content-type: application/json { "connectorLabel": "string", "connectorType": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. connectorLabel The label of the connector. The label is unique for each ConnectorRegistration in your AWS account. Only needed if calling for CUSTOMCONNECTOR connector type/. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+
amazon-appflow-api-013	amazon-appflow-api.pdf	13	Describes the given custom connector registered in your AWS account. This API can be used for custom connectors that are registered in your account and also for Amazon authored connectors. Request Syntax POST /describe-connector HTTP/1.1 Content-type: application/json { "connectorLabel": "string", "connectorType": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. connectorLabel The label of the connector. The label is unique for each ConnectorRegistration in your AWS account. Only needed if calling for CUSTOMCONNECTOR connector type/. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ Required: No connectorType The connector type, such as CUSTOMCONNECTOR, Saleforce, Marketo. Please choose CUSTOMCONNECTOR for Lambda based custom connectors. Type: String DescribeConnector API Version 2020-08-23 53 AmazonAppFlow API Reference Valid Values: Salesforce \| Singular \| Slack \| Redshift \| S3 \| Marketo \| Googleanalytics \| Zendesk \| Servicenow \| Datadog \| Trendmicro \| Snowflake \| Dynatrace \| Infornexus \| Amplitude \| Veeva \| EventBridge \| LookoutMetrics \| Upsolver \| Honeycode \| CustomerProfiles \| SAPOData \| CustomConnector \| Pardot Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "connectorConfiguration": { "authenticationConfig": { "customAuthConfigs": [ { "authParameters": [ { "connectorSuppliedValues": [ "string" ], "description": "string", "isRequired": boolean, "isSensitiveField": boolean, "key": "string", "label": "string" } ], "customAuthenticationType": "string" } ], "isApiKeyAuthSupported": boolean, "isBasicAuthSupported": boolean, "isCustomAuthSupported": boolean, "isOAuth2Supported": boolean, "oAuth2Defaults": { "authCodeUrls": [ "string" ], "oauth2CustomProperties": [ { "connectorSuppliedValues": [ "string" ], "description": "string", "isRequired": boolean, Response Syntax API Version 2020-08-23 54 AmazonAppFlow API Reference "isSensitiveField": boolean, "key": "string", "label": "string", "type": "string" } ], "oauth2GrantTypesSupported": [ "string" ], "oauthScopes": [ "string" ], "tokenUrls": [ "string" ] } }, "canUseAsDestination": boolean, "canUseAsSource": boolean, "connectorArn": "string", "connectorDescription": "string", "connectorLabel": "string", "connectorMetadata": { "Amplitude": { }, "CustomerProfiles": { }, "Datadog": { }, "Dynatrace": { }, "EventBridge": { }, "GoogleAnalytics": { "oAuthScopes": [ "string" ] }, "Honeycode": { "oAuthScopes": [ "string" ] }, "InforNexus": { }, "Marketo": { }, "Pardot": { }, "Redshift": { }, "S3": { }, "Salesforce": { Response Syntax API Version 2020-08-23 55 AmazonAppFlow API Reference "dataTransferApis": [ "string" ], "oauth2GrantTypesSupported": [ "string" ], "oAuthScopes": [ "string" ] }, "SAPOData": { }, "ServiceNow": { }, "Singular": { }, "Slack": { "oAuthScopes": [ "string" ] }, "Snowflake": { "supportedRegions": [ "string" ] }, "Trendmicro": { }, "Upsolver": { }, "Veeva": { }, "Zendesk": { "oAuthScopes": [ "string" ] } }, "connectorModes": [ "string" ], "connectorName": "string", "connectorOwner": "string", "connectorProvisioningConfig": { "lambda": { "lambdaArn": "string" } }, "connectorProvisioningType": "string", "connectorRuntimeSettings": [ { "connectorSuppliedValueOptions": [ "string" ], "dataType": "string", "description": "string", "isRequired": boolean, "key": "string", "label": "string", "scope": "string" Response Syntax API Version 2020-08-23 56 API Reference AmazonAppFlow } ], "connectorType": "string", "connectorVersion": "string", "isPrivateLinkEnabled": boolean, "isPrivateLinkEndpointUrlRequired": boolean, "logoURL": "string", "registeredAt": number, "registeredBy": "string", "supportedApiVersions": [ "string" ], "supportedDataTransferApis": [ { "Name": "string", "Type": "string" } ], "supportedDataTransferTypes": [ "string" ], "supportedDestinationConnectors": [ "string" ], "supportedOperators": [ "string" ], "supportedSchedulingFrequencies": [ "string" ], "supportedTriggerTypes": [ "string" ], "supportedWriteOperations": [ "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. connectorConﬁguration Conﬁguration info of all the connectors that the user requested. Type: ConnectorConﬁguration object Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2020-08-23 57 AmazonAppFlow InternalServerException API Reference An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ResourceNotFoundException The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not found. HTTP Status Code: 404 ValidationException The request has invalid or missing parameters. HTTP Status Code: 400 Examples Describing the given connector This example shows a sample request for the DescribeConnector API and a sample response. Sample Request { "connectorType": "connectorType", "connectorLabel": "connectorLabel" } Sample Response { "connectorConfiguration": { "authenticationConfig": null, "canUseAsDestination": true, "canUseAsSource": true, "connectorArn": null, "connectorDescription": "Salesforce", "connectorLabel": null, "connectorMetadata": Examples API Version 2020-08-23 58 API Reference AmazonAppFlow { "Amplitude": null, "AppIntegrations": null, "CustomerProfiles": null, "Datadog": null, "Dynatrace": null, "EventBridge": null, "GoogleAnalytics": null, "Honeycode": null, "InforNexus": null, "Locke": null, "Marketo": null, "Pardot": null, "Redshift": null, "S3": null, "SAPOData": null, "Salesforce": { "oAuthScopes": [ "api", "refresh_token", "id" ] }, "ServiceNow": null, "Singular": null, "Slack": null, "Snowflake": null, "Trendmicro": null, "Upsolver": null, "Veeva": null, "Zendesk": null }, "connectorModes": null, "connectorName": null, "connectorOwner": null, "connectorProvisioningConfig": null, "connectorProvisioningType": null, "connectorRuntimeSettings": null, "connectorType": "SALESFORCE", "connectorVersion": null, "isPrivateLinkEnabled": true, "isPrivateLinkEndpointUrlRequired": false, Examples API Version 2020-08-23 59 AmazonAppFlow API Reference "logoURL": "insert-logo-here", "registeredAt": null, "registeredBy": null, "supportedApiVersions": null, "supportedDestinationConnectors": [ "S3", "Snowflake", "Redshift", "Salesforce", "EventBridge", "LookoutMetrics", "Locke", "Honeycode", "Upsolver", "CustomerProfiles", "Zendesk", "Marketo", "CustomConnector" ], "supportedOperators": null, "supportedSchedulingFrequencies": [ "BYMINUTE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "ONCE" ], "supportedTriggerTypes": [ "Scheduled", "OnDemand", "Event" ], "supportedWriteOperations": null } } Examples API Version 2020-08-23
amazon-appflow-api-014	amazon-appflow-api.pdf	14	[ "api", "refresh_token", "id" ] }, "ServiceNow": null, "Singular": null, "Slack": null, "Snowflake": null, "Trendmicro": null, "Upsolver": null, "Veeva": null, "Zendesk": null }, "connectorModes": null, "connectorName": null, "connectorOwner": null, "connectorProvisioningConfig": null, "connectorProvisioningType": null, "connectorRuntimeSettings": null, "connectorType": "SALESFORCE", "connectorVersion": null, "isPrivateLinkEnabled": true, "isPrivateLinkEndpointUrlRequired": false, Examples API Version 2020-08-23 59 AmazonAppFlow API Reference "logoURL": "insert-logo-here", "registeredAt": null, "registeredBy": null, "supportedApiVersions": null, "supportedDestinationConnectors": [ "S3", "Snowflake", "Redshift", "Salesforce", "EventBridge", "LookoutMetrics", "Locke", "Honeycode", "Upsolver", "CustomerProfiles", "Zendesk", "Marketo", "CustomConnector" ], "supportedOperators": null, "supportedSchedulingFrequencies": [ "BYMINUTE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "ONCE" ], "supportedTriggerTypes": [ "Scheduled", "OnDemand", "Event" ], "supportedWriteOperations": null } } Examples API Version 2020-08-23 60 AmazonAppFlow See Also API Reference For more information about using this API in one of the language-speciﬁc 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 2020-08-23 61 AmazonAppFlow API Reference DescribeConnectorEntity Provides details regarding the entity used with the connector, with a description of the data model for each ﬁeld in that entity. Request Syntax POST /describe-connector-entity HTTP/1.1 Content-type: application/json { "apiVersion": "string", "connectorEntityName": "string", "connectorProfileName": "string", "connectorType": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. apiVersion The version of the API that's used by the connector. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: No connectorEntityName The entity name for that connector. Type: String Length Constraints: Maximum length of 1024. DescribeConnectorEntity API Version 2020-08-23 62 AmazonAppFlow Pattern: \S+ Required: Yes connectorProﬁleName API Reference The name of the connector proﬁle. The name is unique for each ConnectorProfile in the AWS account. Type: String Length Constraints: Maximum length of 256. Pattern: [\w/!@#+=.-]+ Required: No connectorType The type of connector application, such as Salesforce, Amplitude, and so on. Type: String Valid Values: Salesforce \| Singular \| Slack \| Redshift \| S3 \| Marketo \| Googleanalytics \| Zendesk \| Servicenow \| Datadog \| Trendmicro \| Snowflake \| Dynatrace \| Infornexus \| Amplitude \| Veeva \| EventBridge \| LookoutMetrics \| Upsolver \| Honeycode \| CustomerProfiles \| SAPOData \| CustomConnector \| Pardot Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "connectorEntityFields": [ { "customProperties": { "string" : "string" }, "defaultValue": "string", Response Syntax API Version 2020-08-23 63 AmazonAppFlow API Reference "description": "string", "destinationProperties": { "isCreatable": boolean, "isDefaultedOnCreate": boolean, "isNullable": boolean, "isUpdatable": boolean, "isUpsertable": boolean, "supportedWriteOperations": [ "string" ] }, "identifier": "string", "isDeprecated": boolean, "isPrimaryKey": boolean, "label": "string", "parentIdentifier": "string", "sourceProperties": { "isQueryable": boolean, "isRetrievable": boolean, "isTimestampFieldForIncrementalQueries": boolean }, "supportedFieldTypeDetails": { "v1": { "fieldLengthRange": { "maximum": number, "minimum": number }, "fieldType": "string", "fieldValueRange": { "maximum": number, "minimum": number }, "filterOperators": [ "string" ], "supportedDateFormat": "string", "supportedValues": [ "string" ], "valueRegexPattern": "string" } } } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Elements API Version 2020-08-23 64 AmazonAppFlow API Reference The following data is returned in JSON format by the service. connectorEntityFields Describes the ﬁelds for that connector entity. For example, for an account entity, the ﬁelds would be account name, account ID, and so on. Type: Array of ConnectorEntityField objects Errors For information about the errors that are common to all actions, see Common Errors. ConnectorAuthenticationException An error occurred when authenticating with the connector endpoint. HTTP Status Code: 401 ConnectorServerException An error occurred when retrieving data from the connector endpoint. HTTP Status Code: 400 InternalServerException An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ResourceNotFoundException The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not found. HTTP Status Code: 404 ValidationException The request has invalid or missing parameters. HTTP Status Code: 400 Errors API Version 2020-08-23 65 AmazonAppFlow Examples DescribeConnectorEntity example API Reference This example shows a sample request and response for the DescribeConnectorEntity API Sample Request { "connectorEntityName": "tickets", "connectorProfileName": "connector_profile_name", "connectorType": "Zendesk" } Sample Response { "connectorEntityFields": [ { "description": "Account ID", "destinationProperties": { "isCreatable": false, "isNullable": false, "isUpdatable": false, "isUpsertable": false, "supportedWriteOperations": [ "UPDATE", "UPSERT" ] }, "identifier": "Id", "label": "Account ID", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "id", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] Examples API Version 2020-08-23 66 API Reference AmazonAppFlow } } }, { "description": "Deleted", "destinationProperties": { "isCreatable": false, "isNullable": false, "isUpdatable": false, "isUpsertable": false, "supportedWriteOperations": [] }, "identifier": "IsDeleted", "label": "Deleted", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "boolean", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [ "true", "false" ] } } }, { "description": "Master
amazon-appflow-api-015	amazon-appflow-api.pdf	15	ID", "destinationProperties": { "isCreatable": false, "isNullable": false, "isUpdatable": false, "isUpsertable": false, "supportedWriteOperations": [ "UPDATE", "UPSERT" ] }, "identifier": "Id", "label": "Account ID", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "id", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] Examples API Version 2020-08-23 66 API Reference AmazonAppFlow } } }, { "description": "Deleted", "destinationProperties": { "isCreatable": false, "isNullable": false, "isUpdatable": false, "isUpsertable": false, "supportedWriteOperations": [] }, "identifier": "IsDeleted", "label": "Deleted", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "boolean", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [ "true", "false" ] } } }, { "description": "Master Record ID", "destinationProperties": { "isCreatable": false, "isNullable": true, "isUpdatable": false, "isUpsertable": false, "supportedWriteOperations": [] }, "identifier": "MasterRecordId", "label": "Master Record ID", "sourceProperties": { "isQueryable": true, Examples API Version 2020-08-23 67 AmazonAppFlow API Reference "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "reference", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Account Name", "destinationProperties": { "isCreatable": true, "isNullable": false, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "Name", "label": "Account Name", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", "filterOperators": [ "CONTAINS", "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Account Type", "destinationProperties": { "isCreatable": true, "isNullable": true, Examples API Version 2020-08-23 68 AmazonAppFlow API Reference "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "Type", "label": "Account Type", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "picklist", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Parent Account ID", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "ParentId", "label": "Parent Account ID", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "reference", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } Examples API Version 2020-08-23 69 API Reference AmazonAppFlow }, { "description": "Billing Street", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "BillingStreet", "label": "Billing Street", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "textarea", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Billing City", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "BillingCity", "label": "Billing City", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", Examples API Version 2020-08-23 70 AmazonAppFlow API Reference "filterOperators": [ "CONTAINS", "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Billing State/Province", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "BillingState", "label": "Billing State/Province", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", "filterOperators": [ "CONTAINS", "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Billing Zip/Postal Code", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] Examples API Version 2020-08-23 71 AmazonAppFlow }, "identifier": "BillingPostalCode", "label": "Billing Zip/Postal Code", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", "filterOperators": [ "CONTAINS", "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Billing Country", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "BillingCountry", "label": "Billing Country", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", "filterOperators": [ "CONTAINS", "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] } Examples API Reference API Version 2020-08-23 72 API Reference AmazonAppFlow } }, { "description": "Billing Latitude", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "BillingLatitude", "label": "Billing Latitude", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "double", "filterOperators": [ "NOT_EQUAL_TO", "EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Billing Longitude", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "BillingLongitude", "label": "Billing Longitude", "sourceProperties": { Examples API Version 2020-08-23 73 AmazonAppFlow API Reference "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "double", "filterOperators": [ "NOT_EQUAL_TO", "EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Billing Geocode Accuracy", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "BillingGeocodeAccuracy", "label": "Billing Geocode Accuracy", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "picklist", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { Examples API Version 2020-08-23 74 AmazonAppFlow API Reference "description": "Billing Address", "destinationProperties": { "isCreatable": false, "isNullable": true, "isUpdatable": false, "isUpsertable": false, "supportedWriteOperations": [] }, "identifier": "BillingAddress", "label": "Billing Address", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "address", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Shipping Street", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "ShippingStreet", "label": "Shipping Street", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "textarea", "filterOperators": [ "EQUAL_TO" Examples
amazon-appflow-api-016	amazon-appflow-api.pdf	16	"filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { Examples API Version 2020-08-23 74 AmazonAppFlow API Reference "description": "Billing Address", "destinationProperties": { "isCreatable": false, "isNullable": true, "isUpdatable": false, "isUpsertable": false, "supportedWriteOperations": [] }, "identifier": "BillingAddress", "label": "Billing Address", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "address", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Shipping Street", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "ShippingStreet", "label": "Shipping Street", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "textarea", "filterOperators": [ "EQUAL_TO" Examples API Version 2020-08-23 75 API Reference AmazonAppFlow ], "supportedValues": [] } } }, { "description": "Shipping City", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "ShippingCity", "label": "Shipping City", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", "filterOperators": [ "CONTAINS", "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Shipping State/Province", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "ShippingState", "label": "Shipping State/Province", "sourceProperties": { Examples API Version 2020-08-23 76 AmazonAppFlow API Reference "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", "filterOperators": [ "CONTAINS", "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Shipping Zip/Postal Code", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "ShippingPostalCode", "label": "Shipping Zip/Postal Code", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", "filterOperators": [ "CONTAINS", "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Shipping Country", Examples API Version 2020-08-23 77 AmazonAppFlow API Reference "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "ShippingCountry", "label": "Shipping Country", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", "filterOperators": [ "CONTAINS", "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Shipping Latitude", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "ShippingLatitude", "label": "Shipping Latitude", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "double", "filterOperators": [ Examples API Version 2020-08-23 78 AmazonAppFlow API Reference "NOT_EQUAL_TO", "EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Shipping Longitude", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "ShippingLongitude", "label": "Shipping Longitude", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "double", "filterOperators": [ "NOT_EQUAL_TO", "EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Shipping Geocode Accuracy", "destinationProperties": { Examples API Version 2020-08-23 79 AmazonAppFlow API Reference "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "ShippingGeocodeAccuracy", "label": "Shipping Geocode Accuracy", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "picklist", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Shipping Address", "destinationProperties": { "isCreatable": false, "isNullable": true, "isUpdatable": false, "isUpsertable": false, "supportedWriteOperations": [] }, "identifier": "ShippingAddress", "label": "Shipping Address", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "address", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] Examples API Version 2020-08-23 80 API Reference AmazonAppFlow } } }, { "description": "Account Phone", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "Phone", "label": "Account Phone", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "phone", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Account Fax", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "Fax", "label": "Account Fax", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { Examples API Version 2020-08-23 81 API Reference AmazonAppFlow "v1": { "fieldType": "phone", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Account Number", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "AccountNumber", "label": "Account Number", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", "filterOperators": [ "CONTAINS", "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Website", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] Examples API Version 2020-08-23 82 API Reference AmazonAppFlow }, "identifier": "Website", "label": "Website", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "url", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Photo URL", "destinationProperties": { "isCreatable": false, "isNullable": true, "isUpdatable": false, "isUpsertable": false, "supportedWriteOperations": [] }, "identifier": "PhotoUrl", "label": "Photo URL", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "url", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "SIC Code", Examples API Version 2020-08-23 83 AmazonAppFlow API Reference "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "Sic", "label": "SIC Code", "sourceProperties": { "isQueryable": true, "isRetrievable": true },
amazon-appflow-api-017	amazon-appflow-api.pdf	17	true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "url", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Photo URL", "destinationProperties": { "isCreatable": false, "isNullable": true, "isUpdatable": false, "isUpsertable": false, "supportedWriteOperations": [] }, "identifier": "PhotoUrl", "label": "Photo URL", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "url", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "SIC Code", Examples API Version 2020-08-23 83 AmazonAppFlow API Reference "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "Sic", "label": "SIC Code", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", "filterOperators": [ "CONTAINS", "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Industry", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "Industry", "label": "Industry", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "picklist", "filterOperators": [ Examples API Version 2020-08-23 84 AmazonAppFlow API Reference "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Annual Revenue", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "AnnualRevenue", "label": "Annual Revenue", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "currency", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Employees", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "NumberOfEmployees", "label": "Employees", "sourceProperties": { "isQueryable": true, Examples API Version 2020-08-23 85 AmazonAppFlow API Reference "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "int", "filterOperators": [ "NOT_EQUAL_TO", "EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Ownership", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "Ownership", "label": "Ownership", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "picklist", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Ticker Symbol", Examples API Version 2020-08-23 86 AmazonAppFlow API Reference "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "TickerSymbol", "label": "Ticker Symbol", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", "filterOperators": [ "CONTAINS", "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Account Description", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "Description", "label": "Account Description", "sourceProperties": { "isQueryable": false, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "textarea", "filterOperators": [ Examples API Version 2020-08-23 87 AmazonAppFlow API Reference "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Account Rating", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "Rating", "label": "Account Rating", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "picklist", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Account Site", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "Site", "label": "Account Site", "sourceProperties": { "isQueryable": true, Examples API Version 2020-08-23 88 AmazonAppFlow API Reference "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", "filterOperators": [ "CONTAINS", "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Owner ID", "destinationProperties": { "isCreatable": true, "isNullable": false, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "OwnerId", "label": "Owner ID", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "reference", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Created Date", "destinationProperties": { "isCreatable": false, "isNullable": false, Examples API Version 2020-08-23 89 AmazonAppFlow API Reference "isUpdatable": false, "isUpsertable": false, "supportedWriteOperations": [] }, "identifier": "CreatedDate", "label": "Created Date", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "datetime", "filterOperators": [ "EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "BETWEEN" ], "supportedValues": [] } } }, { "description": "Created By ID", "destinationProperties": { "isCreatable": false, "isNullable": false, "isUpdatable": false, "isUpsertable": false, "supportedWriteOperations": [] }, "identifier": "CreatedById", "label": "Created By ID", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "reference", "filterOperators": [ Examples API Version 2020-08-23 90 AmazonAppFlow API Reference "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Last Modified Date", "destinationProperties": { "isCreatable": false, "isNullable": false, "isUpdatable": false, "isUpsertable": false, "supportedWriteOperations": [] }, "identifier": "LastModifiedDate", "label": "Last Modified Date", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "datetime", "filterOperators": [ "EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "BETWEEN" ], "supportedValues": [] } } }, { "description": "Last Modified By ID", "destinationProperties": { "isCreatable": false, "isNullable": false, "isUpdatable": false, "isUpsertable": false, "supportedWriteOperations": [] Examples API Version 2020-08-23 91 API Reference AmazonAppFlow }, "identifier": "LastModifiedById", "label": "Last Modified By ID", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "reference", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "System Modstamp", "destinationProperties": { "isCreatable": false, "isNullable": false, "isUpdatable": false, "isUpsertable": false, "supportedWriteOperations": [] }, "identifier": "SystemModstamp", "label": "System Modstamp", "sourceProperties": { "isQueryable": true,
amazon-appflow-api-018	amazon-appflow-api.pdf	18	"v1": { "fieldType": "datetime", "filterOperators": [ "EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "BETWEEN" ], "supportedValues": [] } } }, { "description": "Last Modified By ID", "destinationProperties": { "isCreatable": false, "isNullable": false, "isUpdatable": false, "isUpsertable": false, "supportedWriteOperations": [] Examples API Version 2020-08-23 91 API Reference AmazonAppFlow }, "identifier": "LastModifiedById", "label": "Last Modified By ID", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "reference", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "System Modstamp", "destinationProperties": { "isCreatable": false, "isNullable": false, "isUpdatable": false, "isUpsertable": false, "supportedWriteOperations": [] }, "identifier": "SystemModstamp", "label": "System Modstamp", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "datetime", "filterOperators": [ "EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "BETWEEN" ], "supportedValues": [] Examples API Version 2020-08-23 92 API Reference AmazonAppFlow } } }, { "description": "Last Activity", "destinationProperties": { "isCreatable": false, "isNullable": true, "isUpdatable": false, "isUpsertable": false, "supportedWriteOperations": [] }, "identifier": "LastActivityDate", "label": "Last Activity", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "date", "filterOperators": [ "EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "BETWEEN" ], "supportedValues": [] } } }, { "description": "Last Viewed Date", "destinationProperties": { "isCreatable": false, "isNullable": true, "isUpdatable": false, "isUpsertable": false, "supportedWriteOperations": [] }, "identifier": "LastViewedDate", "label": "Last Viewed Date", Examples API Version 2020-08-23 93 AmazonAppFlow API Reference "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "datetime", "filterOperators": [ "EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "BETWEEN" ], "supportedValues": [] } } }, { "description": "Last Referenced Date", "destinationProperties": { "isCreatable": false, "isNullable": true, "isUpdatable": false, "isUpsertable": false, "supportedWriteOperations": [] }, "identifier": "LastReferencedDate", "label": "Last Referenced Date", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "datetime", "filterOperators": [ "EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "BETWEEN" Examples API Version 2020-08-23 94 API Reference AmazonAppFlow ], "supportedValues": [] } } }, { "description": "Data.com Key", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "Jigsaw", "label": "Data.com Key", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", "filterOperators": [ "CONTAINS", "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Jigsaw Company ID", "destinationProperties": { "isCreatable": false, "isNullable": true, "isUpdatable": false, "isUpsertable": false, "supportedWriteOperations": [] }, "identifier": "JigsawCompanyId", "label": "Jigsaw Company ID", "sourceProperties": { Examples API Version 2020-08-23 95 AmazonAppFlow API Reference "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", "filterOperators": [ "CONTAINS", "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Clean Status", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "CleanStatus", "label": "Clean Status", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "picklist", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Account Source", "destinationProperties": { "isCreatable": true, Examples API Version 2020-08-23 96 AmazonAppFlow API Reference "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "AccountSource", "label": "Account Source", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "picklist", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "D-U-N-S Number", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "DunsNumber", "label": "D-U-N-S Number", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", "filterOperators": [ "CONTAINS", "EQUAL_TO", "NOT_EQUAL_TO" ], Examples API Version 2020-08-23 97 AmazonAppFlow API Reference "supportedValues": [] } } }, { "description": "Tradestyle", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "Tradestyle", "label": "Tradestyle", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", "filterOperators": [ "CONTAINS", "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "NAICS Code", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "NaicsCode", "label": "NAICS Code", "sourceProperties": { "isQueryable": true, Examples API Version 2020-08-23 98 AmazonAppFlow API Reference "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", "filterOperators": [ "CONTAINS", "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "NAICS Description", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "NaicsDesc", "label": "NAICS Description", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", "filterOperators": [ "CONTAINS", "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Year Started", "destinationProperties": { Examples API Version 2020-08-23 99 AmazonAppFlow API Reference "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "YearStarted", "label": "Year Started", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", "filterOperators": [ "CONTAINS", "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "SIC Description", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "SicDesc", "label": "SIC Description", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", "filterOperators": [ "CONTAINS", Examples API Version 2020-08-23 100 AmazonAppFlow API Reference "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] }
amazon-appflow-api-019	amazon-appflow-api.pdf	19	Examples API Version 2020-08-23 99 AmazonAppFlow API Reference "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "YearStarted", "label": "Year Started", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", "filterOperators": [ "CONTAINS", "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "SIC Description", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "SicDesc", "label": "SIC Description", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", "filterOperators": [ "CONTAINS", Examples API Version 2020-08-23 100 AmazonAppFlow API Reference "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "D&B Company ID", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "DandbCompanyId", "label": "D&B Company ID", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "reference", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Operating Hour ID", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "OperatingHoursId", "label": "Operating Hour ID", "sourceProperties": { Examples API Version 2020-08-23 101 AmazonAppFlow API Reference "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "reference", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Customer Priority", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "CustomerPriority__c", "label": "Customer Priority", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "picklist", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "SLA", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, Examples API Version 2020-08-23 102 AmazonAppFlow API Reference "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "SLA__c", "label": "SLA", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "picklist", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Active", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "Active__c", "label": "Active", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "picklist", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, Examples API Version 2020-08-23 103 API Reference AmazonAppFlow { "description": "Number of Locations", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "NumberofLocations__c", "label": "Number of Locations", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "double", "filterOperators": [ "NOT_EQUAL_TO", "EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "Upsell Opportunity", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "UpsellOpportunity__c", "label": "Upsell Opportunity", "sourceProperties": { "isQueryable": true, "isRetrievable": true Examples API Version 2020-08-23 104 API Reference AmazonAppFlow }, "supportedFieldTypeDetails": { "v1": { "fieldType": "picklist", "filterOperators": [ "EQUAL_TO" ], "supportedValues": [] } } }, { "description": "SLA Serial Number", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "SLASerialNumber__c", "label": "SLA Serial Number", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", "filterOperators": [ "CONTAINS", "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] } } }, { "description": "SLA Expiration Date", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, Examples API Version 2020-08-23 105 AmazonAppFlow API Reference "isUpsertable": true, "supportedWriteOperations": [] }, "identifier": "SLAExpirationDate__c", "label": "SLA Expiration Date", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "date", "filterOperators": [ "EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "BETWEEN" ], "supportedValues": [] } } }, { "description": "extId", "destinationProperties": { "isCreatable": true, "isNullable": true, "isUpdatable": true, "isUpsertable": true, "supportedWriteOperations": [ "UPSERT" ] }, "identifier": "extId__c", "label": "extId", "sourceProperties": { "isQueryable": true, "isRetrievable": true }, "supportedFieldTypeDetails": { "v1": { "fieldType": "string", Examples API Version 2020-08-23 106 AmazonAppFlow API Reference "filterOperators": [ "CONTAINS", "EQUAL_TO", "NOT_EQUAL_TO" ], "supportedValues": [] } } } ] } See Also For more information about using this API in one of the language-speciﬁc 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 2020-08-23 107 AmazonAppFlow API Reference DescribeConnectorProﬁles Returns a list of connector-profile details matching the provided connector-profile names and connector-types. Both input lists are optional, and you can use them to ﬁlter the result. If no names or connector-types are provided, returns all connector proﬁles in a paginated form. If there is no match, this operation returns an empty list. Request Syntax POST /describe-connector-profiles HTTP/1.1 Content-type: application/json { "connectorLabel": "string", "connectorProfileNames": [ "string" ], "connectorType": "string", "maxResults": number, "nextToken": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. connectorLabel The name of the connector. The name
amazon-appflow-api-020	amazon-appflow-api.pdf	20	connector-profile details matching the provided connector-profile names and connector-types. Both input lists are optional, and you can use them to ﬁlter the result. If no names or connector-types are provided, returns all connector proﬁles in a paginated form. If there is no match, this operation returns an empty list. Request Syntax POST /describe-connector-profiles HTTP/1.1 Content-type: application/json { "connectorLabel": "string", "connectorProfileNames": [ "string" ], "connectorType": "string", "maxResults": number, "nextToken": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. connectorLabel The name of the connector. The name is unique for each ConnectorRegistration in your AWS account. Only needed if calling for CUSTOMCONNECTOR connector type/. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ Required: No DescribeConnectorProﬁles API Version 2020-08-23 108 AmazonAppFlow connectorProﬁleNames API Reference The name of the connector proﬁle. The name is unique for each ConnectorProfile in the AWS account. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 100 items. Length Constraints: Maximum length of 256. Pattern: [\w/!@#+=.-]+ Required: No connectorType The type of connector, such as Salesforce, Amplitude, and so on. Type: String Valid Values: Salesforce \| Singular \| Slack \| Redshift \| S3 \| Marketo \| Googleanalytics \| Zendesk \| Servicenow \| Datadog \| Trendmicro \| Snowflake \| Dynatrace \| Infornexus \| Amplitude \| Veeva \| EventBridge \| LookoutMetrics \| Upsolver \| Honeycode \| CustomerProfiles \| SAPOData \| CustomConnector \| Pardot Required: No maxResults Speciﬁes the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations). Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No nextToken The pagination token for the next page of data. Type: String Length Constraints: Maximum length of 2048. Request Body API Version 2020-08-23 109 API Reference AmazonAppFlow Pattern: \S+ Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "connectorProfileDetails": [ { "connectionMode": "string", "connectorLabel": "string", "connectorProfileArn": "string", "connectorProfileName": "string", "connectorProfileProperties": { "Amplitude": { }, "CustomConnector": { "oAuth2Properties": { "oAuth2GrantType": "string", "tokenUrl": "string", "tokenUrlCustomProperties": { "string" : "string" } }, "profileProperties": { "string" : "string" } }, "Datadog": { "instanceUrl": "string" }, "Dynatrace": { "instanceUrl": "string" }, "GoogleAnalytics": { }, "Honeycode": { }, "InforNexus": { "instanceUrl": "string" Response Syntax API Version 2020-08-23 110 API Reference AmazonAppFlow }, "Marketo": { "instanceUrl": "string" }, "Pardot": { "businessUnitId": "string", "instanceUrl": "string", "isSandboxEnvironment": boolean }, "Redshift": { "bucketName": "string", "bucketPrefix": "string", "clusterIdentifier": "string", "dataApiRoleArn": "string", "databaseName": "string", "databaseUrl": "string", "isRedshiftServerless": boolean, "roleArn": "string", "workgroupName": "string" }, "Salesforce": { "instanceUrl": "string", "isSandboxEnvironment": boolean, "usePrivateLinkForMetadataAndAuthorization": boolean }, "SAPOData": { "applicationHostUrl": "string", "applicationServicePath": "string", "clientNumber": "string", "disableSSO": boolean, "logonLanguage": "string", "oAuthProperties": { "authCodeUrl": "string", "oAuthScopes": [ "string" ], "tokenUrl": "string" }, "portNumber": number, "privateLinkServiceName": "string" }, "ServiceNow": { "instanceUrl": "string" }, "Singular": { }, Response Syntax API Version 2020-08-23 111 AmazonAppFlow API Reference "Slack": { "instanceUrl": "string" }, "Snowflake": { "accountName": "string", "bucketName": "string", "bucketPrefix": "string", "privateLinkServiceName": "string", "region": "string", "stage": "string", "warehouse": "string" }, "Trendmicro": { }, "Veeva": { "instanceUrl": "string" }, "Zendesk": { "instanceUrl": "string" } }, "connectorType": "string", "createdAt": number, "credentialsArn": "string", "lastUpdatedAt": number, "privateConnectionProvisioningState": { "failureCause": "string", "failureMessage": "string", "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. connectorProﬁleDetails Returns information about the connector proﬁles associated with the ﬂow. Response Elements API Version 2020-08-23 112 AmazonAppFlow API Reference Type: Array of ConnectorProﬁle objects nextToken The pagination token for the next page of data. If nextToken=null, this means that all records have been fetched. Type: String Length Constraints: Maximum length of 2048. Pattern: \S+ Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ValidationException The request has invalid or missing parameters. HTTP Status Code: 400 Examples DescribeConnectorProﬁles example This example shows a sample request and response for the DescribeConnectorProfiles API. Sample Request { "connectorProfileNames": ["OldMarketoProfile","non-existing-name"], "connectorTypes": ["Marketo","Salesforce"] } Errors API Version 2020-08-23 113 AmazonAppFlow Sample Response { "connectorProfileDetails": [ { API Reference "arn": "arn:aws:appflow:region:<AccountId>:connectorprofile/OldMarketoProfile", "configuration": { "api_version": "v1", "connection_mode": "Public", "credentials_arn": "arn:aws:secretsmanager:region:<AccountId>:secret:<secret>", "instanceUrl": "MarketoUrl" }, "connectionMode": "Public", "connectorProfileArn": "arn:aws:appflow:region:<AccountId>:connectorprofile/ OldMarketoProfile", "connectorProfileName": "OldMarketoProfile", "connectorProfileProps": { "Amplitude": null, "Datadog": null, "Dynatrace": null, "GoogleAnalytics": null, "InforNexus": null, "Marketo": { "apiVersion": "v1", "instanceUrl": "MarketoUrl" }, "Redshift": null, "Salesforce": null, "ServiceNow": null, "Singular": null, "Slack": null, "Snowflake": null, "Trendmicro": null, "Veeva": null, "Zendesk": null }, "connectorType": "Marketo", "createdAt": "created_at_value", "credentialsArn": "arn:aws:secretsmanager:region:<AccountId>:secret:<secret>", "label": "OldMarketoProfile", "lastUpdated": "lastupdated_value", "lastUpdatedAt": "lastupdated_at_value" } ], Examples API Version 2020-08-23 114 AmazonAppFlow "nextToken": null } DescribeConnectorProﬁles example API Reference This example shows a sample request and response for the DescribeConnectorProfiles API.
amazon-appflow-api-021	amazon-appflow-api.pdf	21	{ API Reference "arn": "arn:aws:appflow:region:<AccountId>:connectorprofile/OldMarketoProfile", "configuration": { "api_version": "v1", "connection_mode": "Public", "credentials_arn": "arn:aws:secretsmanager:region:<AccountId>:secret:<secret>", "instanceUrl": "MarketoUrl" }, "connectionMode": "Public", "connectorProfileArn": "arn:aws:appflow:region:<AccountId>:connectorprofile/ OldMarketoProfile", "connectorProfileName": "OldMarketoProfile", "connectorProfileProps": { "Amplitude": null, "Datadog": null, "Dynatrace": null, "GoogleAnalytics": null, "InforNexus": null, "Marketo": { "apiVersion": "v1", "instanceUrl": "MarketoUrl" }, "Redshift": null, "Salesforce": null, "ServiceNow": null, "Singular": null, "Slack": null, "Snowflake": null, "Trendmicro": null, "Veeva": null, "Zendesk": null }, "connectorType": "Marketo", "createdAt": "created_at_value", "credentialsArn": "arn:aws:secretsmanager:region:<AccountId>:secret:<secret>", "label": "OldMarketoProfile", "lastUpdated": "lastupdated_value", "lastUpdatedAt": "lastupdated_at_value" } ], Examples API Version 2020-08-23 114 AmazonAppFlow "nextToken": null } DescribeConnectorProﬁles example API Reference This example shows a sample request and response for the DescribeConnectorProfiles API. Sample Request { "connectorProfileNames": ["OldMarketoProfile", "non-existing-name"], "connectorTypes": ["Marketo", "Salesforce", "CustomConnector"], "connectorLabel": "MyCustomConnectorLabel" } Sample Response { "connectorProfileDetails": [ { "arn": "arn:aws:appflow:region:<AccountId>:connectorprofile/OldMarketoProfile", "configuration": { "api_version": "v1", "connection_mode": "Public", "credentials_arn": "arn:aws:secretsmanager:region:<AccountId>:secret:<secret>", "instanceUrl": "MarketoUrl" }, "connectionMode": "Public", "connectorProfileArn": "arn:aws:appflow:region:<AccountId>:connectorprofile/ OldMarketoProfile", "connectorProfileName": "OldMarketoProfile", "connectorProfileProps": { "Amplitude": null, "Datadog": null, "Dynatrace": null, "GoogleAnalytics": null, "InforNexus": null, "Marketo": { "apiVersion": "v1", "instanceUrl": "MarketoUrl" Examples API Version 2020-08-23 115 API Reference AmazonAppFlow }, "Redshift": null, "Salesforce": null, "ServiceNow": null, "Singular": null, "Slack": null, "Snowflake": null, "Trendmicro": null, "Veeva": null, "Zendesk": null }, "connectorType": "Marketo", "createdAt": "2022-02-22T15:31:41.467000-08:00", "credentialsArn": "arn:aws:secretsmanager:region:<AccountId>:secret:<secret>", "label": "OldMarketoProfile", "lastUpdatedAt": "2022-02-22T15:31:41.467000-08:00" } ], "nextToken": null } See Also For more information about using this API in one of the language-speciﬁc 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 2020-08-23 116 AmazonAppFlow DescribeConnectors API Reference Describes the connectors vended by Amazon AppFlow for speciﬁed connector types. If you don't specify a connector type, this operation describes all connectors vended by Amazon AppFlow. If there are more connectors than can be returned in one page, the response contains a nextToken object, which can be be passed in to the next call to the DescribeConnectors API operation to retrieve the next page. Request Syntax POST /describe-connectors HTTP/1.1 Content-type: application/json { "connectorTypes": [ "string" ], "maxResults": number, "nextToken": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. connectorTypes The type of connector, such as Salesforce, Amplitude, and so on. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 100 items. Valid Values: Salesforce \| Singular \| Slack \| Redshift \| S3 \| Marketo \| Googleanalytics \| Zendesk \| Servicenow \| Datadog \| Trendmicro \| Snowflake \| Dynatrace \| Infornexus \| Amplitude \| Veeva \| EventBridge \| LookoutMetrics \| Upsolver \| Honeycode \| CustomerProfiles \| SAPOData \| CustomConnector \| Pardot DescribeConnectors API Version 2020-08-23 117 AmazonAppFlow Required: No maxResults API Reference The maximum number of items that should be returned in the result set. The default is 20. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No nextToken The pagination token for the next page of data. Type: String Length Constraints: Maximum length of 2048. Pattern: \S+ Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "connectorConfigurations": { "string" : { "authenticationConfig": { "customAuthConfigs": [ { "authParameters": [ { "connectorSuppliedValues": [ "string" ], "description": "string", "isRequired": boolean, "isSensitiveField": boolean, "key": "string", "label": "string" } ], Response Syntax API Version 2020-08-23 118 AmazonAppFlow API Reference "customAuthenticationType": "string" } ], "isApiKeyAuthSupported": boolean, "isBasicAuthSupported": boolean, "isCustomAuthSupported": boolean, "isOAuth2Supported": boolean, "oAuth2Defaults": { "authCodeUrls": [ "string" ], "oauth2CustomProperties": [ { "connectorSuppliedValues": [ "string" ], "description": "string", "isRequired": boolean, "isSensitiveField": boolean, "key": "string", "label": "string", "type": "string" } ], "oauth2GrantTypesSupported": [ "string" ], "oauthScopes": [ "string" ], "tokenUrls": [ "string" ] } }, "canUseAsDestination": boolean, "canUseAsSource": boolean, "connectorArn": "string", "connectorDescription": "string", "connectorLabel": "string", "connectorMetadata": { "Amplitude": { }, "CustomerProfiles": { }, "Datadog": { }, "Dynatrace": { }, "EventBridge": { }, "GoogleAnalytics": { "oAuthScopes": [ "string" ] }, Response Syntax API Version 2020-08-23 119 AmazonAppFlow API Reference "Honeycode": { "oAuthScopes": [ "string" ] }, "InforNexus": { }, "Marketo": { }, "Pardot": { }, "Redshift": { }, "S3": { }, "Salesforce": { "dataTransferApis": [ "string" ], "oauth2GrantTypesSupported": [ "string" ], "oAuthScopes": [ "string" ] }, "SAPOData": { }, "ServiceNow": { }, "Singular": { }, "Slack": { "oAuthScopes": [ "string" ] }, "Snowflake": { "supportedRegions": [ "string" ] }, "Trendmicro": { }, "Upsolver": { }, "Veeva": { }, "Zendesk": { "oAuthScopes": [ "string" ] } }, "connectorModes": [ "string" ], "connectorName": "string", "connectorOwner": "string", "connectorProvisioningConfig": { Response Syntax API Version 2020-08-23 120 AmazonAppFlow API Reference "lambda": { "lambdaArn": "string" } }, "connectorProvisioningType": "string", "connectorRuntimeSettings": [ { "connectorSuppliedValueOptions": [ "string" ], "dataType": "string", "description": "string", "isRequired": boolean, "key": "string", "label": "string", "scope": "string" } ], "connectorType": "string", "connectorVersion": "string", "isPrivateLinkEnabled":
amazon-appflow-api-022	amazon-appflow-api.pdf	22	"string" ], "oAuthScopes": [ "string" ] }, "SAPOData": { }, "ServiceNow": { }, "Singular": { }, "Slack": { "oAuthScopes": [ "string" ] }, "Snowflake": { "supportedRegions": [ "string" ] }, "Trendmicro": { }, "Upsolver": { }, "Veeva": { }, "Zendesk": { "oAuthScopes": [ "string" ] } }, "connectorModes": [ "string" ], "connectorName": "string", "connectorOwner": "string", "connectorProvisioningConfig": { Response Syntax API Version 2020-08-23 120 AmazonAppFlow API Reference "lambda": { "lambdaArn": "string" } }, "connectorProvisioningType": "string", "connectorRuntimeSettings": [ { "connectorSuppliedValueOptions": [ "string" ], "dataType": "string", "description": "string", "isRequired": boolean, "key": "string", "label": "string", "scope": "string" } ], "connectorType": "string", "connectorVersion": "string", "isPrivateLinkEnabled": boolean, "isPrivateLinkEndpointUrlRequired": boolean, "logoURL": "string", "registeredAt": number, "registeredBy": "string", "supportedApiVersions": [ "string" ], "supportedDataTransferApis": [ { "Name": "string", "Type": "string" } ], "supportedDataTransferTypes": [ "string" ], "supportedDestinationConnectors": [ "string" ], "supportedOperators": [ "string" ], "supportedSchedulingFrequencies": [ "string" ], "supportedTriggerTypes": [ "string" ], "supportedWriteOperations": [ "string" ] } }, "connectors": [ { "applicationType": "string", "connectorDescription": "string", "connectorLabel": "string", "connectorModes": [ "string" ], Response Syntax API Version 2020-08-23 121 AmazonAppFlow API Reference "connectorName": "string", "connectorOwner": "string", "connectorProvisioningType": "string", "connectorType": "string", "connectorVersion": "string", "registeredAt": number, "registeredBy": "string", "supportedDataTransferTypes": [ "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. connectorConﬁgurations The conﬁguration that is applied to the connectors used in the ﬂow. Type: String to ConnectorConﬁguration object map Valid Keys: Salesforce \| Singular \| Slack \| Redshift \| S3 \| Marketo \| Googleanalytics \| Zendesk \| Servicenow \| Datadog \| Trendmicro \| Snowflake \| Dynatrace \| Infornexus \| Amplitude \| Veeva \| EventBridge \| LookoutMetrics \| Upsolver \| Honeycode \| CustomerProfiles \| SAPOData \| CustomConnector \| Pardot connectors Information about the connectors supported in Amazon AppFlow. Type: Array of ConnectorDetail objects nextToken The pagination token for the next page of data. Type: String Length Constraints: Maximum length of 2048. Response Elements API Version 2020-08-23 122 AmazonAppFlow Pattern: \S+ Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ValidationException The request has invalid or missing parameters. HTTP Status Code: 400 Examples DescribeConnectors example This example shows a sample request and response for the DescribeConnectors API using Marketo and Salesforce. The second sample shows how to proceed if you receive nextToken. Sample Request { "connectorTypes": ["Marketo","Salesforce"] } { "connectorTypes": ["Marketo","Salesforce"], "nextToken": "nextToken_value" } Sample Response { "connectorConfigurations": { "Marketo": { Errors API Version 2020-08-23 123 AmazonAppFlow API Reference "canUseAsDestination": false, "canUseAsSource": true, "compatibleConnectors": [ "S3", "Snowflake", "Salesforce", "Redshift" ], "connectorMetadata": { "Amplitude": null, "Datadog": null, "Dynatrace": null, "GoogleAnalytics": null, "InforNexus": null, "Marketo": {}, "Redshift": null, "S3": null, "Salesforce": null, "ServiceNow": null, "Singular": null, "Slack": null, "Snowflake": null, "Trendmicro": null, "Veeva": null, "Zendesk": null }, "connectorSpecificConfiguration": { "api_version": "v1" }, "credentialKeys": [ "accessToken", "clientId", "clientSecret" ], "displayName": "Marketo", "hasLogoImage": false, "isPrivateLinkEnabled": false, "isPrivateLinkEndpointUrlRequired": false, "privateLinkEndpointServiceUrl": null, "supportedDestinationConnectors": [ "S3", "Snowflake", "Salesforce", "Redshift" Examples API Version 2020-08-23 124 API Reference AmazonAppFlow ], "supportedFrequencies": [ "Hour", "Day", "Week", "Month", "Once" ], "supportedRegions": null, "supportedSchedulingFrequencies": [ "Hour", "Day", "Week", "Month", "Once" ], "supportedTriggerTypes": [ "Scheduled", "OnDemand" ], "supportedTriggers": [ "Scheduled", "OnDemand" ] }, "Salesforce": { "canUseAsDestination": true, "canUseAsSource": true, "compatibleConnectors": [ "S3", "Snowflake", "Redshift", "Salesforce" ], "connectorMetadata": { "Amplitude": null, "Datadog": null, "Dynatrace": null, "GoogleAnalytics": null, "InforNexus": null, "Marketo": null, "Redshift": null, "S3": null, "Salesforce": { Examples API Version 2020-08-23 125 AmazonAppFlow API Reference "authScopes": [ "api", "refresh_token", "id" ] }, "ServiceNow": null, "Singular": null, "Slack": null, "Snowflake": null, "Trendmicro": null, "Veeva": null, "Zendesk": null }, "connectorSpecificConfiguration": { "api_version": "v47.0", "auth_scopes": "[api, refresh_token, id]", "bulk_api_path": "services/data", "query_api_path": "query", "sobject_api_path": "sobjects" }, "credentialKeys": [ "accessToken", "refreshToken", "clientId", "clientSecret" ], "displayName": "Salesforce", "hasLogoImage": false, "isPrivateLinkEnabled": false, "isPrivateLinkEndpointUrlRequired": false, "privateLinkEndpointServiceUrl": null, "supportedDestinationConnectors": [ "S3", "Snowflake", "Redshift", "Salesforce" ], "supportedFrequencies": [ "Minute", "Hour", "Day", "Week", "Month", Examples API Version 2020-08-23 126 AmazonAppFlow "Once" ], "supportedRegions": null, "supportedSchedulingFrequencies": [ API Reference "Minute", "Hour", "Day", "Week", "Month", "Once" ], "supportedTriggerTypes": [ "Scheduled", "OnDemand", "Event" ], "supportedTriggers": [ "Scheduled", "OnDemand", "Event" ] } }, "nextToken": null, "pageToken": null } See Also For more information about using this API in one of the language-speciﬁc 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 See Also API Version 2020-08-23 127 AmazonAppFlow • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 128 API Reference AmazonAppFlow DescribeFlow Provides a description of the speciﬁed ﬂow. Request Syntax POST /describe-flow HTTP/1.1 Content-type: application/json
amazon-appflow-api-023	amazon-appflow-api.pdf	23	this API in one of the language-speciﬁc 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 See Also API Version 2020-08-23 127 AmazonAppFlow • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 128 API Reference AmazonAppFlow DescribeFlow Provides a description of the speciﬁed ﬂow. Request Syntax POST /describe-flow HTTP/1.1 Content-type: application/json { "flowName": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. ﬂowName The speciﬁed name of the ﬂow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "createdAt": number, "createdBy": "string", "description": "string", DescribeFlow API Version 2020-08-23 129 AmazonAppFlow API Reference "destinationFlowConfigList": [ { "apiVersion": "string", "connectorProfileName": "string", "connectorType": "string", "destinationConnectorProperties": { "CustomConnector": { "customProperties": { "string" : "string" }, "entityName": "string", "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "idFieldNames": [ "string" ], "writeOperationType": "string" }, "CustomerProfiles": { "domainName": "string", "objectTypeName": "string" }, "EventBridge": { "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "object": "string" }, "Honeycode": { "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "object": "string" }, "LookoutMetrics": { }, "Marketo": { "errorHandlingConfig": { "bucketName": "string", Response Syntax API Version 2020-08-23 130 AmazonAppFlow API Reference "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "object": "string" }, "Redshift": { "bucketPrefix": "string", "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "intermediateBucketName": "string", "object": "string" }, "S3": { "bucketName": "string", "bucketPrefix": "string", "s3OutputFormatConfig": { "aggregationConfig": { "aggregationType": "string", "targetFileSize": number }, "fileType": "string", "prefixConfig": { "pathPrefixHierarchy": [ "string" ], "prefixFormat": "string", "prefixType": "string" }, "preserveSourceDataTyping": boolean } }, "Salesforce": { "dataTransferApi": "string", "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "idFieldNames": [ "string" ], "object": "string", "writeOperationType": "string" }, "SAPOData": { Response Syntax API Version 2020-08-23 131 AmazonAppFlow API Reference "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "idFieldNames": [ "string" ], "objectPath": "string", "successResponseHandlingConfig": { "bucketName": "string", "bucketPrefix": "string" }, "writeOperationType": "string" }, "Snowflake": { "bucketPrefix": "string", "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "intermediateBucketName": "string", "object": "string" }, "Upsolver": { "bucketName": "string", "bucketPrefix": "string", "s3OutputFormatConfig": { "aggregationConfig": { "aggregationType": "string", "targetFileSize": number }, "fileType": "string", "prefixConfig": { "pathPrefixHierarchy": [ "string" ], "prefixFormat": "string", "prefixType": "string" } } }, "Zendesk": { "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean Response Syntax API Version 2020-08-23 132 AmazonAppFlow API Reference }, "idFieldNames": [ "string" ], "object": "string", "writeOperationType": "string" } } } ], "flowArn": "string", "flowName": "string", "flowStatus": "string", "flowStatusMessage": "string", "kmsArn": "string", "lastRunExecutionDetails": { "mostRecentExecutionMessage": "string", "mostRecentExecutionStatus": "string", "mostRecentExecutionTime": number }, "lastRunMetadataCatalogDetails": [ { "catalogType": "string", "partitionRegistrationOutput": { "message": "string", "result": "string", "status": "string" }, "tableName": "string", "tableRegistrationOutput": { "message": "string", "result": "string", "status": "string" } } ], "lastUpdatedAt": number, "lastUpdatedBy": "string", "metadataCatalogConfig": { "glueDataCatalog": { "databaseName": "string", "roleArn": "string", "tablePrefix": "string" } }, "schemaVersion": number, Response Syntax API Version 2020-08-23 133 AmazonAppFlow API Reference "sourceFlowConfig": { "apiVersion": "string", "connectorProfileName": "string", "connectorType": "string", "incrementalPullConfig": { "datetimeTypeFieldName": "string" }, "sourceConnectorProperties": { "Amplitude": { "object": "string" }, "CustomConnector": { "customProperties": { "string" : "string" }, "dataTransferApi": { "Name": "string", "Type": "string" }, "entityName": "string" }, "Datadog": { "object": "string" }, "Dynatrace": { "object": "string" }, "GoogleAnalytics": { "object": "string" }, "InforNexus": { "object": "string" }, "Marketo": { "object": "string" }, "Pardot": { "object": "string" }, "S3": { "bucketName": "string", "bucketPrefix": "string", "s3InputFormatConfig": { "s3InputFileType": "string" Response Syntax API Version 2020-08-23 134 API Reference AmazonAppFlow } }, "Salesforce": { "dataTransferApi": "string", "enableDynamicFieldUpdate": boolean, "includeDeletedRecords": boolean, "object": "string" }, "SAPOData": { "objectPath": "string", "paginationConfig": { "maxPageSize": number }, "parallelismConfig": { "maxParallelism": number } }, "ServiceNow": { "object": "string" }, "Singular": { "object": "string" }, "Slack": { "object": "string" }, "Trendmicro": { "object": "string" }, "Veeva": { "documentType": "string", "includeAllVersions": boolean, "includeRenditions": boolean, "includeSourceFiles": boolean, "object": "string" }, "Zendesk": { "object": "string" } } }, "tags": { "string" : "string" }, Response Syntax API Version 2020-08-23 135 API Reference AmazonAppFlow "tasks": [ { "connectorOperator": { "Amplitude": "string", "CustomConnector": "string", "Datadog": "string", "Dynatrace": "string", "GoogleAnalytics": "string", "InforNexus": "string", "Marketo": "string", "Pardot": "string", "S3": "string", "Salesforce": "string", "SAPOData": "string", "ServiceNow": "string", "Singular": "string", "Slack": "string", "Trendmicro": "string", "Veeva": "string", "Zendesk": "string" }, "destinationField": "string", "sourceFields": [ "string" ], "taskProperties": { "string" : "string" }, "taskType": "string" } ], "triggerConfig": { "triggerProperties": { "Scheduled": { "dataPullMode": "string", "firstExecutionFrom": number, "flowErrorDeactivationThreshold": number, "scheduleEndTime": number, "scheduleExpression": "string", "scheduleOffset": number, "scheduleStartTime": number, "timezone": "string" } }, "triggerType": "string" } Response Syntax API Version 2020-08-23 136 AmazonAppFlow } Response Elements If
amazon-appflow-api-024	amazon-appflow-api.pdf	24	Version 2020-08-23 135 API Reference AmazonAppFlow "tasks": [ { "connectorOperator": { "Amplitude": "string", "CustomConnector": "string", "Datadog": "string", "Dynatrace": "string", "GoogleAnalytics": "string", "InforNexus": "string", "Marketo": "string", "Pardot": "string", "S3": "string", "Salesforce": "string", "SAPOData": "string", "ServiceNow": "string", "Singular": "string", "Slack": "string", "Trendmicro": "string", "Veeva": "string", "Zendesk": "string" }, "destinationField": "string", "sourceFields": [ "string" ], "taskProperties": { "string" : "string" }, "taskType": "string" } ], "triggerConfig": { "triggerProperties": { "Scheduled": { "dataPullMode": "string", "firstExecutionFrom": number, "flowErrorDeactivationThreshold": number, "scheduleEndTime": number, "scheduleExpression": "string", "scheduleOffset": number, "scheduleStartTime": number, "timezone": "string" } }, "triggerType": "string" } Response Syntax API Version 2020-08-23 136 AmazonAppFlow } 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. API Reference createdAt Speciﬁes when the ﬂow was created. Type: Timestamp createdBy The ARN of the user who created the ﬂow. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ description A description of the ﬂow. Type: String Length Constraints: Maximum length of 2048. Pattern: [\w!@#\-.?,\s]* destinationFlowConﬁgList The conﬁguration that controls how Amazon AppFlow transfers data to the destination connector. Type: Array of DestinationFlowConﬁg objects ﬂowArn The ﬂow's Amazon Resource Name (ARN). Type: String Length Constraints: Maximum length of 512. Response Elements API Version 2020-08-23 137 AmazonAppFlow API Reference Pattern: arn:aws:appflow:.:[0-9]+:. ﬂowName The speciﬁed name of the ﬂow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ ﬂowStatus Indicates the current status of the ﬂow. Type: String Valid Values: Active \| Deprecated \| Deleted \| Draft \| Errored \| Suspended ﬂowStatusMessage Contains an error message if the ﬂow status is in a suspended or error state. This applies only to scheduled or event-triggered ﬂows. Type: String Length Constraints: Maximum length of 2048. Pattern: [\s\w/!@#+=.-]* kmsArn 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 Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:aws:kms:.:[0-9]+:. lastRunExecutionDetails Describes the details of the most recent ﬂow run. Response Elements API Version 2020-08-23 138 AmazonAppFlow Type: ExecutionDetails object lastRunMetadataCatalogDetails API Reference Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated ﬂow run. Type: Array of MetadataCatalogDetail objects lastUpdatedAt Speciﬁes when the ﬂow was last updated. Type: Timestamp lastUpdatedBy Speciﬁes the user name of the account that performed the most recent update. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ metadataCatalogConﬁg Speciﬁes the conﬁguration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated ﬂow. When Amazon AppFlow catalogs the data from a ﬂow, it stores metadata in a data catalog. Type: MetadataCatalogConﬁg object schemaVersion The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your ﬂow conﬁguration: • Source-to-destination ﬁeld mappings • Field data types • Partition keys Type: Long sourceFlowConﬁg The conﬁguration that controls how Amazon AppFlow retrieves data from the source connector. Response Elements API Version 2020-08-23 139 AmazonAppFlow API Reference Type: SourceFlowConﬁg object tags The tags used to organize, track, or control access for your ﬂow. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Maximum length of 256. Value Pattern: [\s\w+-=\.:/@]* tasks A list of tasks that Amazon AppFlow performs while transferring the data in the ﬂow run. Type: Array of Task objects triggerConﬁg The trigger settings that determine how and when the ﬂow runs. Type: TriggerConﬁg object Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ResourceNotFoundException The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not found. HTTP Status Code: 404 Errors API Version 2020-08-23 140 AmazonAppFlow Examples DescribeFlow example API Reference This example shows a sample request and response for the DescribeFlow API. Sample Request { "flowName": "name" } Sample Response { "createdAt": "2022-02-22T15:31:41.467000-08:00", "createdBy": "user", "description": null, "destinationFlowConfigList": [ { "aggregationConfig": null, "connectorProfileName": "connector_profile_name", "connectorType": "S3", "destinationConnectorProps": { "Redshift": null, "S3": { "bucketKey": null, "bucketName": "salesforceaccountflowbucket" }, "Salesforce": null, "Snowflake": null } } ], "flowArn": "flow_arn_value", "flowName": "test_flow_ondemand_10", "flowStatus": "Active", "flowStatusMessage": null, "kmsArn": null, "lastRunExecutionDetails": null, "lastUpdatedAt": "2022-02-22T15:31:41.467000-08:00", Examples API Version 2020-08-23 141 AmazonAppFlow "lastUpdatedBy": "user", "sourceFlowConfig": { "connectorProfileName": "connectorProfileName", API Reference "connectorType": "Salesforce", "sourceConnectorProps": { "Amplitude": null, "Datadog": null, "Dynatrace": null, "GoogleAnalytics":
amazon-appflow-api-025	amazon-appflow-api.pdf	25	140 AmazonAppFlow Examples DescribeFlow example API Reference This example shows a sample request and response for the DescribeFlow API. Sample Request { "flowName": "name" } Sample Response { "createdAt": "2022-02-22T15:31:41.467000-08:00", "createdBy": "user", "description": null, "destinationFlowConfigList": [ { "aggregationConfig": null, "connectorProfileName": "connector_profile_name", "connectorType": "S3", "destinationConnectorProps": { "Redshift": null, "S3": { "bucketKey": null, "bucketName": "salesforceaccountflowbucket" }, "Salesforce": null, "Snowflake": null } } ], "flowArn": "flow_arn_value", "flowName": "test_flow_ondemand_10", "flowStatus": "Active", "flowStatusMessage": null, "kmsArn": null, "lastRunExecutionDetails": null, "lastUpdatedAt": "2022-02-22T15:31:41.467000-08:00", Examples API Version 2020-08-23 141 AmazonAppFlow "lastUpdatedBy": "user", "sourceFlowConfig": { "connectorProfileName": "connectorProfileName", API Reference "connectorType": "Salesforce", "sourceConnectorProps": { "Amplitude": null, "Datadog": null, "Dynatrace": null, "GoogleAnalytics": null, "InforNexus": null, "Marketo": null, "Redshift": null, "S3": null, "Salesforce": { "object": "Account" }, "ServiceNow": null, "Singular": null, "Slack": null, "Snowflake": null, "Trendmicro": null, "Veeva": null, "Zendesk": null } }, "tags": { "internalId": "Internal_Id_value", "resourceArn": "resource_arn_value" }, "tasks": [ { "connectorOperator": null, "destinationField": "Id", "operator": "NO_OP", "sourceFields": ["Id"], "taskProperties": { "DESTINATION_DATA_TYPE": "id", "SOURCE_DATA_TYPE": "id" }, Examples API Version 2020-08-23 142 API Reference AmazonAppFlow "taskType": "Mapping" }, { "connectorOperator": null, "destinationField": "Name", "operator": "NO_OP", "sourceFields": ["Name"], "taskProperties": { "DESTINATION_DATA_TYPE": "string", "SOURCE_DATA_TYPE": "string" }, "taskType": "Mapping" }, { "connectorOperator": null, "destinationField": null, "operator": "PROJECTION", "sourceFields": ["Id","Name"], "taskProperties": {}, "taskType": "Filtering" } ], "triggerConfig": { "triggerProps": { "ScheduledTriggerProps": null }, "triggerType": "OnDemand" } } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See Also API Version 2020-08-23 143 AmazonAppFlow • 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 2020-08-23 144 AmazonAppFlow API Reference DescribeFlowExecutionRecords Fetches the execution history of the ﬂow. Request Syntax POST /describe-flow-execution-records HTTP/1.1 Content-type: application/json { "flowName": "string", "maxResults": number, "nextToken": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. ﬂowName The speciﬁed name of the ﬂow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ Required: Yes maxResults Speciﬁes the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations). Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. DescribeFlowExecutionRecords API Version 2020-08-23 145 API Reference AmazonAppFlow Required: No nextToken The pagination token for the next page of data. Type: String Length Constraints: Maximum length of 2048. Pattern: \S+ Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "flowExecutions": [ { "dataPullEndTime": number, "dataPullStartTime": number, "executionId": "string", "executionResult": { "bytesProcessed": number, "bytesWritten": number, "errorInfo": { "executionMessage": "string", "putFailuresCount": number }, "maxPageSize": number, "numParallelProcesses": number, "recordsProcessed": number }, "executionStatus": "string", "lastUpdatedAt": number, "metadataCatalogDetails": [ { "catalogType": "string", "partitionRegistrationOutput": { "message": "string", Response Syntax API Version 2020-08-23 146 AmazonAppFlow API Reference "result": "string", "status": "string" }, "tableName": "string", "tableRegistrationOutput": { "message": "string", "result": "string", "status": "string" } } ], "startedAt": number } ], "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. ﬂowExecutions Returns a list of all instances when this ﬂow was run. Type: Array of ExecutionRecord objects nextToken The pagination token for the next page of data. Type: String Length Constraints: Maximum length of 2048. Pattern: \S+ Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2020-08-23 147 AmazonAppFlow InternalServerException API Reference An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ResourceNotFoundException The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not found. HTTP Status Code: 404 ValidationException The request has invalid or missing parameters. HTTP Status Code: 400 Examples DescribeFlowExecutionRecords examples This example shows sample requests and responses for the DescribeFlowExecutionRecords API. Sample Request { "flowName": "name", "maxResults": 1 } Sample Response { "flowExecutionList": [ { "executionId": "Execution_ID", "executionMessage": "Request failed with Trendmicro Status Code 404: , RequestId: RequestId_value", "executionMetadata": Examples API Version 2020-08-23 148 API Reference AmazonAppFlow { "bytesProcessed": 234, "bytesWritten": 0, "numFailures": 878, "numFilteredRecords": 0, "numPutFailures": 978978, "reason": null, "recordsProcessed": 23342, "terminateFlow": false }, "executionResult": { "bytesProcessed": 234, "bytesWritten": 0, "errorInfo": { "executionMessage": "Request failed with Trendmicro Status Code 404: , RequestId: RequestId_value", "putFailuresCount": 978978 }, "recordsProcessed": 23342 }, "executionStartTime": "2022-02-22T15:31:41.467000-08:00", "executionStatus": "Error", "lastUpdatedAt": "2022-02-22T15:31:41.467000-08:00", "startedAt": "2022-02-22T15:31:41.467000-08:00" } ], "nextToken": "next_token_value" } Sample Request { "flowName": "test-new-create", "maxResults": 1, "nextToken": "next_token_value" } Sample Response { "flowExecutionList": [ Examples API Version 2020-08-23 149 AmazonAppFlow { API

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.