654 min read

AWS CLI Command Reference Guide A - K

November 11, 2021

AWS CLI Reference Guide a-k

This guide details all of the commands available starting with A - K for each AWS service supported by the AWS command line interface application.

For commands starting with L - Z please see this post : 

https://www.hava.io/blog/aws-cli-command-reference-guide-l-z

The format of an AWS CLI instruction is:

aws [options] <command/service> <subcommand> [parameters]

 Eg:   aws --output table  s3  ls s3://mybucket

In the above example :

[options] :  --output table   (tells aws to ignore the default output format and return a table)

<command/service> : s3

<subcommand> : ls  (list the buckets or contents of a nominated S3 bucket if one is included)

[parameters] : s3://mybucket  (tells aws to list the contents of an S3 bucket called “mybucket”

In this guide we’ll first detail the options that are available to each CLI command prior to the command/service and then look at the services and their subcommands.

The [options] available to all CLI commands are:

--ca-bundle - Specify CA certificate bundle to use when verifying SSL

--color - Support color output (on/off/auto)

--cli-binary-format - Formatting style for binary blobs (base64 / raw-in-base64)

--cli-connect-timeout - Maximum socket connect timeout in seconds (default is 60)

--cli-read-timeout - Maximum socket read time in seconds (default is 60)

--debug -  Turn on debug logging

--endpoint-url - Specify URL to override the command’s default endpoint

--no-cli-auto-prompt - Disables auto-prompt for single command

--no-cli-pager - Disables pager use for output

--no-paginate - Disable automatic pagination

--no-sign-request - Don’t load credentials for the command

--no-verify-ssl - Override the default usage of SSL when connecting to AWS

--output - Format in json / text / table / yaml / yaml-stream

--profile - Use a specific profile from your credentials file

--query - A JMESPath query to use in filtering the response data

--region - Specify a region to override your default region

--version - Display the version of the CLI

AWS CLI commands

accessanalyzer

IAM Access Analyzer helps identify policies granting access to an external principal.

Commands :

account

AWS account management operations.

Commands:

acm

AWS Certificate Manager used to control SSL/TLS certificates for your AWS based websites and applications.

Commands:

acm-pca

ACM Private certificate authority API reference, providing syntax and usage examples of the actions and data types involved in creating and managing private certificate authorities for your organization.

Commands:

alexaforbusiness

You can build your own context-aware voice skills using the Alexa Skills Kit and the Alexa for Business API operations.

Commands : 

amp

Amazon managed service for Prometheus to monitor containerized applications and infrastructure at scale.

Commands :

amplify

Amplify helps developers deploy and develop cloud based mobile and web apps.

Commands:

amplifybackend

AWS Amplify’s Admin API

Commands:

apigateway

Amazon API Gateway enables developers to develop mobile and web application backends by enabling the connection to Lambda, EC2 or publicly addressable web services outside of AWS.

Commands : 

apigatewaymanagementapi

The AWS API gateway management API is used to directly manage runtime aspects of your deployed APIs.

Commands : 

apigatewayv2

AWS API Gateway V2

Commands : 

appconfig

AppConfig creates, manages and deploys application configurations for apps built on EC2, Lambda, Containers, mobile apps or IoT.

Commands:

appflow

Amazon AppFlow API reference used to integrate SaaS applications like Salesforce, Marketo, Slack with AWS services like S3 and Redshift.

Commands:

appIntegrations

AWS AppIntegrations is a service to help connect to external applications.

Commands : 

application-autoscaling

With Application Auto Scaling, you can configure automatic scaling for the following resources:

  • Amazon AppStream 2.0 fleets
  • Amazon Aurora Replicas
  • Amazon Comprehend document classification and entity recognizer endpoints
  • Amazon DynamoDB tables and global secondary indexes throughput capacity
  • Amazon ECS services
  • Amazon ElastiCache for Redis clusters (replication groups)
  • Amazon EMR clusters
  • Amazon Keyspaces (for Apache Cassandra) tables
  • Lambda function provisioned concurrency
  • Amazon Managed Streaming for Apache Kafka broker storage
  • Amazon Neptune clusters
  • Amazon SageMaker endpoint variants
  • Spot Fleets (Amazon EC2)
  • Custom resources provided by your own applications or services

Commands:

application-insights

Amazon CloudWatch Application Insights is a service that helps you detect common problems with your applications.

Commands : 

applicationcostprofiler

The AWS Application Cost Profiler API provides programmatic access to view, create, update, and delete application cost report definitions, as well as to import your usage data into the Application Cost Profiler service.

Commands : 

appmesh

App Mesh gives you consistent visibility and network traffic controls for every microservice in an application. You can use App Mesh with Amazon Web Services Fargate, Amazon ECS, Amazon EKS, Kubernetes on Amazon Web Services, and Amazon EC2.

Commands :

apprunner

AppRunner takes your container or source code and provisions the AWS resources required to run and support the application.

Commands : 

appstream

AppStream 2.0 is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. AppStream 2.0 manages the AWS resources that are required to host and run your applications, scales automatically, and provides access to your users on demand.

Commands : 

appsync

Appsync is used to create and interact with data sources using GraphQL from your application.

athena

Amazon Athena is an interactive query service that lets you use standard SQL to analyze data directly in Amazon S3. You can point Athena at your data in Amazon S3

Commands : 

auditmanager

Audit Manager is a service that provides automated evidence collection so that you can continually audit your Amazon Web Services usage.

Commands : 

autoscaling

EC2 Auto Scaling launches and terminates EC2 instances based on user-defined criteria.

Commands : 

autoscaling-plans

Use AWS Auto Scaling to create scaling plans for your applications to automatically scale your scalable AWS resources.

Commands : 

backup

Backup simplifies the creation and restoration of backups with reporting and auditing.

Commands : 

batch

Runs batch computing workloads using large amounts of compute resources.

Commands : 

braket

Braket is Amazon’s quantum computing service.

Commands : 

budgets

The AWS Budgets API enables you to use AWS Budgets to plan your service usage, service costs, and instance reservations.

Commands : 

ce

You can use the Cost Explorer API to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage.

Commands : 

chime

The Amazon Chime API (application programming interface) is designed for developers to perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors.

Commands : 

chime-sdk-identity

The Amazon Chime SDK Identity APIs in this section allow software developers to create and manage unique instances of their messaging applications.

Commands : 

chime-sdk-meetings

Allows software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and receive meeting notifications.

Commands : 

chime-sdk-messaging

Allows software developers to send and receive messages in custom messaging applications. These APIs depend on the frameworks provided by the Amazon Chime SDK Identity APIs

Commands : 

cloud9

Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.

Commands : 

cloudcontrol

Allows CRUDL operations (create, read, update, delete, list) on a wide variety of AWS and third party resources.

Commands : 

clouddirectory

Cloud Directory is a sub component of the AWS Directory Service.

Commands : 

cloudformation

Allows you to deploy AWS resources like EC2, EBS, SNS, ELB and Autoscaling from templates, so you can repeatedly and consistently deploy infrastructure. Templates define groups of resources known as stacks.

Commands : 

cloudfront

CloudFront is the AWS global content distribution network (CDN) that has a globally distributed network of proxy servers that cache your content close to users, wherever they reside.

Commands : 

cloudhsm

CloudHSM is a hardware security module that allows you to generate and use your own encryption keys on the AWS cloud.

Commands : 

cloudhsmv2

CloudHSM V2 is an updated hardware security module that allows you to generate and use your own encryption keys on the AWS cloud.

Commands : 

 

cloudsearch

You use the Amazon CloudSearch configuration service to create, configure, and manage search domains.

Commands : 

cloudsearchdomain

CloudSearch API allows you to upload documents to a search domain and then search them.

Commands : 

cloudtrail

CloudTrail is a web service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket.

Commands : 

cloudwatch

Amazon CloudWatch monitors your AWS resources and the applications you run on AWS in real time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.

Commands : 

codeartifact

AWS CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, and pip. You can use CodeArtifact to share packages with development teams and pull packages.

Commands : 

codebuild

AWS CodeBuild is a fully managed build service in the cloud. CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. CodeBuild eliminates the need to provision, manage, and scale your own build servers.

Commands : 

codecommit

AWS CodeCommit is a secure, highly scalable, managed source control service that hosts private Git repositories.

Commands : 

codeguru-reviewer

CodeGuru Reviewer is a service that uses program analysis and machine learning to detect potential defects that are difficult for developers to find and recommends fixes in your Java and Python code.

Commands : 

codeguruprofiler

Amazon CodeGuru Profiler collects runtime performance data from your live applications, and provides recommendations that can help you fine-tune your application performance.

Commands :

codepipeline

AWS CodePipeline is an AWS product that automates the software deployment process, allowing a developer to quickly model, visualize and deliver code for new features and updates.

Commands : 

codestar

AWS CodeStar enables you to quickly develop, build, and deploy applications on AWS. AWS CodeStar provides a unified user interface, enabling you to easily manage your software development activities in one place.

Commands : 

codestar-connections

Connections are configurations that you use to connect AWS resources to external code repositories. Each connection is a resource that can be given to services such as CodePipeline to connect to a third-party repository such as Bitbucket.

Commands :

codestar-notifications

Quickly notify users of codestar operations.

Commands :

cognito-identity

Amazon Cognito Federated Identities is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments.

Commands : 

cognito-idp

Using the Amazon Cognito User Pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.

Commands :

cognito-sync

Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data.

Commands :

Comprehend

Amazon Comprehend is an AWS service for gaining insight into the content of documents.

Commands : 

comprehendmedical

Amazon Comprehend Medical extracts structured information from unstructured clinical text.

Commands :

compute-optimizer

Compute Optimizer is a service that analyzes the configuration and utilization metrics of your AWS compute resources, such as Amazon EC2 instances, Amazon EC2 Auto Scaling groups, Lambda functions, and Amazon EBS volumes.

Commands :

configservice

Config provides a way to keep track of the configurations of all the Amazon Web Services resources associated with your Amazon Web Services account.

Commands : 

configure

Configure AWS CLI options. If this command is run with no arguments, you will be prompted for configuration values such as your AWS Access Key Id and your AWS Secret Access Key.

Commands :

connect

Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.

Commands :

connect-contact-lens

Contact Lens for Amazon Connect enables you to analyze conversations between customer and agents, by using speech transcription, natural language processing, and intelligent search capabilities

Commands : 

connectparticipant

Amazon Connect enables customer contacts through voice or chat.

The APIs described here are used by chat participants, such as agents and customers.

Commands : 

cur

The AWS Cost and Usage Report API enables you to programmatically create, query, and delete AWS Cost and Usage report definitions.

Commands :

customer-profiles

Amazon Connect customer profiles

Commands :

databrew

Glue DataBrew is a visual, cloud-scale data-preparation service.

Commands : 

dataexchange

AWS Data Exchange is a service that makes it easy for AWS customers to exchange data in the cloud. You can use the AWS Data Exchange APIs to create, update, manage, and access file-based data set in the AWS Cloud.

Commands : 

datapipeline

AWS Data Pipeline configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline handles the details of scheduling and ensuring that data dependencies are met.

Commands :

datasync

DataSync is a managed data transfer service that makes it simpler for you to automate moving data between on-premises storage and S3 or EFS

Commands : 

dax

DAX is a managed caching service engineered for Amazon DynamoDB. DAX dramatically speeds up database reads by caching frequently-accessed data from DynamoDB, so applications can access that data with sub-millisecond latency.

Commands :

deploy

AWS CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, serverless AWS Lambda functions, or applications in an Amazon ECS service.

Commands : 

detective

Amazon Detective uses machine learning and purpose-built visualizations to help you analyze and investigate security issues across your AWS workloads.

Commands : 

devicefarm

Device Farm makes it possible for you to test apps on physical phones, tablets, and other devices in the cloud. You can also test web apps on desktop browsers using selenium.

Commands : 

devops-guru

Amazon DevOps Guru is a fully managed service that helps you identify anomalous behavior in business critical operational applications. You specify the AWS resources that you want DevOps Guru to cover, then the Amazon CloudWatch metrics and AWS CloudTrail events related to those resources are analyzed.

Commands : 

directconnect

Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an Direct Connect router. With this connection in place, you can create virtual interfaces directly to the AWS Cloud and to Amazon VPC, bypassing Internet service providers in your network path.

Commands :

discovery

AWS Application Discovery Service helps you plan application migration projects. It automatically identifies servers, virtual machines (VMs), and network dependencies in your on-premises data centers.

Commands : 

dlm

With Amazon Data Lifecycle Manager, you can manage the lifecycle of your Amazon Web Services resources. You create lifecycle policies, which are used to automate operations on the specified resources.

Commands : 

dms

Database Migration Service (DMS) can migrate your data to and from the most widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise (ASE).

Commands :

docdb

Amazon DocumentDB is a managed proprietary NoSQL database service that supports document data structures. As a document database, Amazon DocumentDB can store, query, and index JSON data on AWS.

Commands : 

ds

Directory Service is a web service that makes it easy for you to setup and run directories in the Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active Directory.

Commands : 

dynamodb

Amazon DynamoDB is a fully managed NoSQL database service.

Commands : 

dynamodbstreams

Amazon DynamoDB Streams provides API actions for accessing streams and processing stream records.

Commands : 

ebs

You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create Amazon EBS snapshots, write data directly to your snapshots, read data on your snapshots, and identify the differences or changes between two snapshots.

Commands : 

ec2

Amazon Elastic Compute Cloud (Amazon EC2) provides secure and resizable computing capacity in the AWS Cloud.

Commands : 

ec2-instance-connect

Instance Connect enables sysadmins to issue one-time use SSH public keys to EC2.

Commands : 

ecr

Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service.

Commands : 

ecr-public

Amazon ECR supports public repositories with this API.

Commands : 

ecs

Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster.

Commands : 

efs

Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 instances.

Commands :

eks

Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on AWS.

Commands : 

elastic-inference

Amazon Elastic Inference allows you to attach low-cost GPU-powered acceleration to Amazon EC2 and Sagemaker instances or Amazon ECS tasks, to reduce the cost of running deep learning inference by up to 75%. Amazon Elastic Inference supports TensorFlow, Apache MXNet, PyTorch and ONNX models.

Commands : 

elasticache

Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.

Commands : 

elasticbeanstalk

AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on AWS.

Commands : 

elastictranscoder

Amazon Elastic Transcoder is media transcoding in the cloud. It is designed to be a highly scalable way for developers to convert (or “transcode”) media files from their original source format into versions that will playback on devices like smartphones, tablets and PCs.

Commands : 

elb

A load balancer can distribute incoming traffic across your EC2 instances.

Commands : 

elbv2

A Version 2 load balancer distributes incoming traffic across targets, such as your EC2 instances.

Commands : 

emr

Amazon EMR is a web service that makes it easier to process large amounts of data efficiently. Amazon EMR uses Hadoop processing combined with several Amazon Web Services services to do tasks such as web indexing, data mining, log file analysis, machine learning, scientific simulation, and data warehouse management.

Commands : 

emr-containers

Amazon EMR on EKS provides a deployment option for Amazon EMR that allows you to run open-source big data frameworks on Amazon Elastic Kubernetes Service (Amazon EKS)

Commands : 

es

Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains.

Commands : 

events

Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your resources change state, they automatically send events to an event stream. You can create rules that match selected events in the stream and route them to targets to take action. 

Commands : 

finspace

Amazon FinSpace is a data management and analytics service purpose-built for the financial services industry. This API is used to manage FinSpace environments.

Commands : 

finspace-data

The FinSpace APIs let you take actions inside the FinSpace environment.

Commands : 

firehose

Amazon Kinesis Data Firehose is a fully managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon Elasticsearch Service (Amazon ES), Amazon Redshift, and Splunk.

Commands : 

fis

AWS Fault Injection Simulator is a managed service that enables you to perform fault injection experiments on your AWS workloads.

Commands : 

fms

Firewall Manager administration and maintenance tasks across multiple accounts and resources for a variety of protections, including AWS WAF, AWS Shield Advanced, Amazon VPC security groups, AWS Network Firewall, and Amazon Route 53 Resolver DNS Firewall.

Commands  :

forecast

Provides APIs for creating and managing Amazon Forecast resources.

Commands : 

forecastquery

Provides APIs for creating and managing Amazon Forecast resources.

Commands : 

frauddetector

Amazon Fraud Detector is a fully managed service enabling AWS customers to identify potentially fraudulent activities and catch more online fraud faster.

Commands : 

fsx

Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage.

Commands : 

gamelift

GameLift provides solutions for hosting session-based multiplayer game servers in the cloud

Commands : 

glacier

AWS S3 Glacier is an extremely low-cost storage service that provides secure, durable, and easy-to-use storage for data backup and archival.

Commands : 

globalaccelerator

AWS Global Accelerator is a service in which you create accelerators to improve the performance of your applications for local and global users.

Commands : 

glue

AWS Glue is a serverless data integration service that makes it easy to discover, prepare, and combine data for analytics, machine learning, and application development.

Commands : 

grafana

Amazon Managed Grafana is a fully managed and secure data visualization service that you can use to instantly query, correlate, and visualize operational metrics, logs, and traces from multiple sources.

Commands : 

greengrass

AWS IoT Greengrass is an open-source edge runtime and cloud service that helps you build, deploy, and manage intelligent device software.

Commands : 

greengrassv2

IoT Greengrass V2 brings local compute, messaging, data management, sync, and ML inference capabilities to edge devices. This enables devices to collect and analyze data closer to the source of information, react autonomously to local events, and communicate securely with each other on local networks.

Commands :

groundstation

AWS Ground Station is a fully managed service that enables you to control satellite communications, downlink and process satellite data.

Commands :