API Reference aws-elixir v0.13.1




AWS provides an API to talk with Amazon Web Services.

Amazon Web Services Certificate Manager

This is the Certificate Manager Private Certificate Authority (PCA) API Reference.

Amazon API Gateway

Identity and Access Management Access Analyzer helps identify potential resource-access risks by enabling you to identify any policies that grant access to an external principal.

Operations for Amazon Web Services Account Management

Alexa for Business helps you use Alexa in your organization.

Amazon Managed Service for Prometheus

Amplify enables developers to develop and deploy cloud-powered mobile and web apps.

AWS Amplify Admin API

The Amplify UI Builder API provides a programmatic interface for creating and configuring user interface (UI) component libraries and themes for use in your Amplify applications.

The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs.

Amazon API Gateway V2

Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly deploy application configurations.

AppConfig Data provides the data plane APIs your application uses to retrieve configuration data.

The Amazon AppIntegrations service enables you to configure and reuse connections to external applications.

App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and control microservices.

App Runner

Amazon AppStream 2.0

AppSync provides API actions for creating and interacting with data sources using GraphQL from your application.

Welcome to the Amazon AppFlow API reference.

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

This reference provides descriptions of the AWS Application Cost Profiler API.

Amazon Web Services Application Discovery Service

Amazon CloudWatch Application Insights

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

Welcome to the Audit Manager API reference.

Amazon EC2 Auto Scaling

AWS Auto Scaling


Backup gateway

The frontend service for Cryo Storage.


Amazon Web Services Billing Conductor is a fully managed service that you can use to customize a pro forma version of your billing data each month, to accurately show or chargeback your end customers.

The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.

Use the Amazon Web Services Budgets API to plan your service usage, service costs, and instance reservations.

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.

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

The Amazon Chime SDK media pipeline APIs in this section allow software developers to create Amazon Chime SDK media pipelines that capture, concatenate, or stream your Amazon Chime SDK meetings.

The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and receive meeting notifications.

The Amazon Chime SDK Messaging APIs in this section allow software developers to send and receive messages in custom messaging applications.

Provides credentials and connection details for making requests to AWS services.


For more information about Amazon Web Services Cloud Control API, see the Amazon Web Services Cloud Control API User Guide.

Amazon Cloud Directory


Amazon CloudFront

AWS CloudHSM Service

For more information about AWS CloudHSM, see AWS CloudHSM and the AWS CloudHSM User Guide.

Amazon CloudSearch Configuration Service

You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents.


Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the applications you run on Amazon Web Services in real time.

Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources.

You can use Amazon CloudWatch Logs to monitor, store, and access your log files from EC2 instances, CloudTrail, and other sources.


AWS CodeCommit

AWS CodeDeploy

This section provides documentation for the Amazon CodeGuru Profiler API operations.

This section provides documentation for the Amazon CodeGuru Reviewer API operations.

AWS CodePipeline

AWS CodeStar

AWS CodeStar Connections

CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, pip, and dotnet.

This AWS CodeStar Notifications API Reference provides descriptions and usage examples of the operations and data types for the AWS CodeStar Notifications API.

Amazon Cognito Federated Identities

Using the Amazon Cognito user pools API, you can create a user pool to manage directories and users.

Amazon Cognito Sync

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

Comprehend Medical; extracts structured information from unstructured clinical text.

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


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.

Provide APIs to create and manage Amazon Connect Campaigns.

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.

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

These interfaces allow you to apply the AWS library of pre-defined controls to your organizational units, programmatically.

You can use the Cost Explorer API to programmatically query your cost and usage data.

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

Amazon Connect Customer Profiles

DAX is a managed caching service engineered for Amazon DynamoDB.

Amazon Data Lifecycle Manager

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

This is the API reference for AWS Data Exchange.

AWS Data Pipeline configures and manages a data-driven workflow called a pipeline.


Database Migration Service

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

Amazon DevOps Guru is a fully managed service that helps you identify anomalous behavior in business critical operational applications.

Welcome to the AWS Device Farm API documentation, which contains APIs for

Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable.

Directory Service

Amazon DocumentDB API documentation

AWS Elastic Disaster Recovery Service.

Amazon DynamoDB

Amazon DynamoDB

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.

Amazon EC2 Instance Connect enables system administrators to publish one-time use SSH public keys to EC2, providing users a simple and secure way to connect to their instances.

Amazon Elastic Container Registry

Amazon Elastic Container Registry Public

Amazon Elastic Container Service

Amazon Elastic File System

Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on Amazon Web Services without needing to stand up or maintain your own Kubernetes control plane.

Amazon EMR is a web service that makes it easier to process large amounts of data efficiently.

Amazon EMR Serverless is a new deployment option for Amazon EMR.

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).

Amazon ElastiCache

AWS Elastic Beanstalk

Elastic Inference public APIs.

Elastic Load Balancing

Elastic Load Balancing

AWS Elastic Transcoder Service

Amazon Elasticsearch Configuration Service

Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources.

You can use Amazon CloudWatch Evidently to safely validate new features by serving them to a specified percentage of your users while you roll out the feature.

This is the Firewall Manager API Reference.

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

The FinSpace management service provides the APIs for managing FinSpace environments.

The FinSpace APIs let you take actions inside the FinSpace.

Amazon Kinesis Data Firehose API Reference

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

Provides APIs for creating and managing Amazon Forecast resources.

Provides APIs for creating and managing Amazon Forecast resources.

This is the Amazon Fraud Detector API Reference.

GameLift Service

Amazon S3 Glacier (Glacier) is a storage solution for "cold data."

Global Accelerator


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.

AWS IoT Greengrass seamlessly extends AWS onto physical devices so they can act locally on the data they generate, while still using the cloud for management, analytics, and durable storage.

IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities to edge devices.

Welcome to the AWS Ground Station API Reference.

Amazon GuardDuty is a continuous security monitoring service that analyzes and processes the following data sources: VPC Flow Logs, AWS CloudTrail management event logs, CloudTrail S3 data event logs, EKS audit logs, and DNS logs.

Specifies the behaviour of a HTTP Client.


Amazon HealthLake is a HIPAA eligibile service that allows customers to store, transform, query, and analyze their FHIR-formatted data in a consistent fashion in the cloud.

Amazon Honeycode is a fully managed service that allows you to quickly build mobile and web apps for teams—without programming.

Identity and Access Management

The Identity Store service used by AWS IAM Identity Center (successor to AWS Single Sign-On) provides a single place to retrieve all of your identities (users and groups).

EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date "golden" server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.

AWS Import/Export Service

Amazon Inspector

Amazon Inspector is a vulnerability discovery service that automates continuous scanning for security vulnerabilities within your Amazon EC2 and Amazon ECR environments.


Describes all of the AWS IoT 1-Click device-related API operations for the service.

The AWS IoT 1-Click Projects API Reference

IoT Analytics allows you to collect large amounts of device data, process messages, and store them.

IoT data

AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur.

IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur.

With Fleet Hub for AWS IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets.

AWS IoT Jobs is a service that allows you to define a set of jobs — remote operations that are sent to and executed on one or more devices connected to AWS IoT.

IoT Secure Tunneling

Welcome to the IoT SiteWise API Reference.

AWS IoT Things Graph

IoT TwinMaker is a service that enables you to build operational digital twins of physical systems.

AWS IoT Wireless provides bi-directional communication between internet-connected wireless devices and the AWS Cloud.

Amazon Web Services IoT Core Device Advisor is a cloud-based, fully managed test capability for validating IoT devices during device software development.



The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an Amazon Web Services EventBridge event stream for responses.



The Amazon IVS Chat control-plane API enables you to create and manage Amazon IVS Chat resources.

Specifies the behaviour of a JSON parser.

Key Management Service

The operations for managing an Amazon MSK cluster.

Amazon Kendra is a service for indexing large document sets.

Amazon Keyspaces (for Apache Cassandra) is a scalable, highly available, and managed Apache Cassandra-compatible database service.

Amazon Kinesis Data Streams Service API Reference

Amazon Kinesis Analytics

Amazon Kinesis Data Analytics is a fully managed service that you can use to process and analyze streaming data using Java, SQL, or Scala.

Kinesis Video Streams Signaling Service is a intermediate service that establishes a communication channel for discovering peers, transmitting offers and answers in order to establish peer-to-peer connection in webRTC technology.

Lake Formation


Amazon Lex Build-Time Actions

Amazon Lex provides both build and runtime endpoints.

License Manager makes it easier to manage licenses from software vendors across multiple Amazon Web Services accounts and on-premises servers.

With License Manager, you can create user-based subscriptions to utilize licensed software with a per user subscription fee on Amazon EC2 instances.

Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications.

"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"

Amazon Lookout for Equipment is a machine learning service that uses advanced analytics to identify anomalies in machines from sensor data for use in predictive maintenance.

This is the Amazon Lookout for Metrics API Reference.

This is the Amazon Lookout for Vision API Reference.

Amazon Web Services Mainframe Modernization provides tools and resources to help you plan and implement migration and modernization from mainframes to Amazon Web Services managed runtime environments.

Amazon Mechanical Turk API Reference

Amazon Managed Workflows for Apache Airflow

Definition of the public APIs exposed by Amazon Machine Learning

Amazon Macie Classic

Amazon Macie is a fully managed data security and data privacy service that uses machine learning and pattern matching to discover and protect your sensitive data in AWS.

Amazon Managed Blockchain is a fully managed service for creating and managing blockchain networks using open-source frameworks.

Catalog API actions allow you to manage your entities through list, describe, and update capabilities.

Provides AWS Marketplace business intelligence data on-demand.

AWS Marketplace Entitlement Service

AWS Marketplace Metering Service

API for AWS Elemental MediaConnect

AWS Elemental MediaConvert

API for AWS Elemental MediaLive

AWS Elemental MediaPackage

AWS Elemental MediaPackage VOD

An AWS Elemental MediaStore container is a namespace that holds folders and objects.

An AWS Elemental MediaStore asset is an object, similar to an object in the Amazon S3 service.

Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad insertion and linear channels.

MemoryDB for Redis is a fully managed, Redis-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures.

The Application Migration Service service.

The AWS Migration Hub API methods help to obtain server and application migration status and integrate your resource-specific migration tool by providing a programmatic interface to Migration Hub.

The AWS Migration Hub home region APIs are available specifically for working with your Migration Hub home region.

Amazon Web Services Migration Hub Refactor Spaces

Migration Hub Strategy Recommendations

AWS Mobile Service provides mobile app and website developers with capabilities required to configure AWS resources and bootstrap their developer desktop projects with the necessary SDKs, constants, tools and samples to make use of those resources.

Amazon Mobile Analytics is a service for collecting, visualizing, and understanding app usage data at scale.

Amazon MQ is a managed message broker service for Apache ActiveMQ and RabbitMQ that makes it easy to set up and operate message brokers in the cloud.

Amazon Neptune

This is the API Reference for Network Firewall.

Amazon Web Services enables you to centrally manage your Amazon Web Services Cloud WAN core network and your Transit Gateway network across Amazon Web Services accounts, Regions, and on-premises locations.

Welcome to the Amazon Nimble Studio API reference.

Amazon OpenSearch Configuration Service

AWS OpsWorks

AWS OpsWorks CM

Organizations is a web service that enables you to consolidate your multiple Amazon Web Services accounts into an organization and centrally manage your accounts and their resources.

Amazon Web Services Outposts is a fully managed service that extends Amazon Web Services infrastructure, APIs, and tools to customer premises.

Amazon RDS Performance Insights

AWS Panorama

Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers.

Amazon Personalize can consume real-time user event data, such as stream or click data, and use it for model training either alone or combined with historical data.

Doc Engage API - Amazon Pinpoint API

Amazon Pinpoint Email Service

Pinpoint SMS and Voice Messaging public facing APIs

Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference.

Amazon Polly is a web service that makes it easy to synthesize speech from text.

Amazon Web Services Price List API is a centralized and convenient way to programmatically query Amazon Web Services for services, products, and pricing information.

Amazon Web Services Private 5G is a managed service that makes it easy to deploy, operate, and scale your own private mobile network at your on-premises location.

This is the Proton Service API Reference.

The control plane for Amazon QLDB

The transactional data APIs for Amazon QLDB

Amazon QuickSight API Reference

This is the Resource Access Manager API Reference.

Amazon Relational Database Service

Amazon RDS Data Service

With Amazon CloudWatch RUM, you can perform real-user monitoring to collect client-side data about your web application performance from actual user sessions in real time.

This is the Recycle Bin API Reference.

Amazon Redshift

You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables.

This is an interface reference for Amazon Redshift Serverless.

AWS Resilience Hub helps you proactively prepare and protect your Amazon Web Services applications from disruptions.

AWS Resource Groups

Resource Groups Tagging API

This section provides documentation for the AWS RoboMaker API operations.

AWS Identity and Access Management Roles Anywhere provides a secure way for your workloads such as servers, containers, and applications running outside of AWS to obtain Temporary AWS credentials.

Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service.

Amazon Route 53 API actions let you register domain names and perform related operations.

Welcome to the Routing Control (Recovery Cluster) API Reference Guide for Amazon Route 53 Application Recovery Controller.

Recovery Control Configuration API Reference for Amazon Route 53 Application Recovery Controller

Recovery readiness

When you create a VPC using Amazon VPC, you automatically get DNS resolution within the VPC from Route 53 Resolver.

Amazon Web Services S3 Control provides access to Amazon S3 control plane actions.

Amazon S3 on Outposts provides access to S3 on Outposts operations.

Amazon Simple Email Service

Amazon SES API v2

AWS Step Functions


Product update

We recommend Amazon Web Services Application Migration Service (Amazon Web Services MGN) as the primary migration service for lift-and-shift migrations.

Amazon Simple Notification Service

Welcome to the Amazon SQS API Reference.

Amazon Web Services Systems Manager is a collection of capabilities to help you manage your applications and infrastructure running in the Amazon Web Services Cloud;.

Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web Services-hosted applications.

Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web Services-hosted applications.

AWS IAM Identity Center (successor to AWS Single Sign-On) Portal is a web service that makes it easy for you to assign user access to IAM Identity Center resources such as the AWS access portal.

AWS IAM Identity Center (successor to AWS Single Sign-On) helps you securely create, or connect, your workforce identities and manage their access centrally across AWS accounts and applications.

AWS Single Sign-On (SSO) OpenID Connect (OIDC) is a web service that enables a client (such as AWS CLI or a native application) to register with AWS SSO.

Security Token Service

Amazon Simple Workflow Service

Provides APIs for creating and managing SageMaker resources.

Amazon Augmented AI (Amazon A2I) adds the benefit of human judgment to any machine learning application.

Contains all data plane API operations and data types for the Amazon SageMaker Feature Store.

The Amazon SageMaker runtime API.

SageMaker Edge Manager dataplane service for communicating with active agents.

Savings Plans are a pricing model that offer significant savings on AWS usage (for example, on Amazon EC2 instances).

Amazon EventBridge Schema Registry

Amazon Web Services Secrets Manager

Security Hub provides you with a comprehensive view of the security state of your Amazon Web Services environment and resources.

The AWS Serverless Application Repository makes it easy for developers and enterprises to quickly find and deploy serverless applications in the AWS Cloud.

AWS Service Catalog

Amazon Web Services Service Catalog AppRegistry enables organizations to understand the application context of their Amazon Web Services resources.

With Service Quotas, you can view and manage your quotas easily as your AWS workloads grow.

Shield Advanced

AWS Signer is a fully managed code signing service to help you ensure the trust and integrity of your code.

Amazon SimpleDB is a web service providing the core database functions of data indexing and querying in the cloud.

Amazon Web Services Snow Device Management documentation.

The Amazon Web Services Snow Family provides a petabyte-scale data transport solution that uses secure devices to transfer large amounts of data between your on-premises data centers and Amazon Simple Storage Service (Amazon S3).

Storage Gateway Service

Amazon Web Services Support

Amazon Web Services Support App in Slack

Amazon CloudWatch Synthetics

Amazon Textract detects and analyzes text in documents and converts it into machine-readable text.

Amazon Timestream Query

Amazon Timestream Write

Amazon Transcribe offers three main types of batch transcription: Standard, Medical, and Call Analytics.

Operations and objects for transcribing streaming speech to text.

Transfer Family is a fully managed service that enables the transfer of files over the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS.

Provides translation between one source language and another of the same set of languages.

Amazon Connect Voice ID provides real-time caller authentication and fraud screening.

This is AWS WAF Classic documentation.

This is AWS WAF Classic Regional documentation.


Well-Architected Tool

Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're actively speaking with customers.

The WorkDocs API is designed for the following use cases

Amazon WorkLink is a cloud-based service that provides secure access to internal websites and web apps from iOS and Android phones.

Amazon WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients.

The WorkMail Message Flow API provides access to email messages as they are being sent and received by a WorkMail organization.

Amazon WorkSpaces Service

WorkSpaces Web is a low cost, fully managed WorkSpace built specifically to facilitate secure, web-based workloads.

Specifies the behaviour of a XML parser.

Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.