Create an access key to use the Amazon Lightsail API or the Command Line Interface
Last updated: January 25, 2021
To use the Lightsail API or the Command Line Interface ( CLI), you need to create a new access key. The access key consists of an Access Key ID and a Secret Access Key. Use the following procedures to create the key and configure the CLI to make calls to the Lightsail API.
Step 1: Create a new access key
You can create a new access key in the AWS Identity and Access Management (IAM) console.
Sign in to the the IAM console.
Choose the name of the user for which you want to create an access key. The user you choose should have full access or specific access to Lightsail actions.
Choose the Security credentials tabs.
Choose Create access key under the Access keys section of the page.
You can have a maximum of two access keys (active or inactive) at a time per user. If you already have two access keys, then you must delete one of them before creating a new one. Make sure that an access key is not actively in use before deleting it.
Make note of the Access key ID and Secret access key listed. Choose Show under the Secret access key column to see your Secret access key.
You can copy them from this screen or choose Download Key File to download a .csv file containing the access key ID and secret access key.
Keep your access keys in a safe place. You should name the file something like
MyLightsailKeys.csvso that you don't struggle to find them later. If you've downloaded the CSV file from the IAM console, you should delete it after you've completed step 2. You can create a new access keys later if you need to.
Step 2: Configure the CLI
If you haven't installed the CLI, you can do that now. See Installing the Command Line Interface. After you install the CLI, you need to configure it so you can use it.
Open a terminal window or command prompt.
Paste your Access Key ID from the .csv file you created in the previous step.
Paste your Secret Access Key when prompted.
Enter the Region where your resources are located. For example, if your resources are primarily in Ohio, choose
us-east-2when prompted for the Default region name.
For more information about using the CLI
--regionoption, see General Options in the CLI Reference.
Choose a Default output format, such as