API Reference

Modules

• aws_accessanalyzer
  AWS IAM Access Analyzer helps identify potential resource-access risks by enabling you to identify any policies that grant access to an external principal.
• aws_acm
  AWS Certificate Manager.
• aws_acm_pca
  This is the ACM Private CA API Reference.
• aws_alexa_for_business
  Alexa for Business helps you use Alexa in your organization.
• aws_amp
  Amazon Managed Service for Prometheus.
• aws_amplify
  Amplify enables developers to develop and deploy cloud-powered mobile and web apps.
• aws_amplifybackend
  AWS Amplify Admin API.
• aws_api_gateway
  Amazon API Gateway.
• aws_api_pricing
  AWS Price List Service API (AWS Price List Service) is a centralized and convenient way to programmatically query Amazon Web Services for services, products, and pricing information.
• aws_apigatewaymanagementapi
  The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs.
• aws_apigatewayv2
  Amazon API Gateway V2.
• aws_app_mesh
  AWS App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and control microservices.
• aws_appconfig
  AWS AppConfig.
• aws_appflow
  Welcome to the Amazon AppFlow API reference.
• aws_appintegrations
  The Amazon AppIntegrations APIs are in preview release and are subject to change.
• aws_application_auto_scaling
  With Application Auto Scaling, you can configure automatic scaling for the following resources:.
• aws_application_discovery
  AWS Application Discovery Service.
• aws_application_insights
  Amazon CloudWatch Application Insights.
• aws_appstream
  Amazon AppStream 2.0.
• aws_appsync
  AWS AppSync provides API actions for creating and interacting with data sources using GraphQL from your application.
• aws_athena
  Amazon Athena is an interactive query service that lets you use standard SQL to analyze data directly in Amazon S3.
• aws_auditmanager
  Welcome to the AWS Audit Manager API reference.
• aws_auto_scaling
  Amazon EC2 Auto Scaling.
• aws_auto_scaling_plans
  AWS Auto Scaling.
• aws_backup
  AWS Backup.
• aws_batch
  Using AWS Batch, you can run batch computing workloads on the AWS Cloud.
• aws_braket
  The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.
• aws_budgets
  The AWS Budgets API enables you to use AWS Budgets to plan your service usage, service costs, and instance reservations.
• aws_client
• aws_cloud9
  AWS Cloud9.
• aws_clouddirectory
  Amazon Cloud Directory.
• aws_cloudformation
  AWS CloudFormation.
• aws_cloudfront
  Amazon CloudFront.
• aws_cloudhsm
  AWS CloudHSM Service.
• aws_cloudhsm_v2
  For more information about AWS CloudHSM, see AWS CloudHSM and the AWS CloudHSM User Guide.
• aws_cloudsearch
  Amazon CloudSearch Configuration Service.
• aws_cloudsearchdomain
  You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents.
• aws_cloudtrail
  AWS CloudTrail.
• aws_cloudwatch
  Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the applications you run on AWS in real time.
• aws_cloudwatch_events
  Amazon EventBridge helps you to respond to state changes in your AWS resources.
• aws_cloudwatch_logs
  You can use Amazon CloudWatch Logs to monitor, store, and access your log files from EC2 instances, AWS CloudTrail, or other sources.
• aws_codeartifact
  AWS CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, NuGet, and pip.
• aws_codebuild
  AWS CodeBuild.
• aws_codecommit
  AWS CodeCommit.
• aws_codedeploy
  AWS CodeDeploy.
• aws_codeguru_reviewer
  This section provides documentation for the Amazon CodeGuru Reviewer API operations.
• aws_codeguruprofiler
  This section provides documentation for the Amazon CodeGuru Profiler API operations.
• aws_codepipeline
  AWS CodePipeline.
• aws_codestar
  AWS CodeStar.
• aws_codestar_notifications
  This AWS CodeStar Notifications API Reference provides descriptions and usage examples of the operations and data types for the AWS CodeStar Notifications API.
• aws_cognito_identity
  Amazon Cognito Federated Identities.
• aws_cognito_identity_provider
  Using the Amazon Cognito User Pools API, you can create a user pool to manage directories and users.
• aws_cognitosync
  Amazon Cognito Sync.
• aws_comprehend
  Amazon Comprehend is an AWS service for gaining insight into the content of documents.
• aws_comprehendmedical
  Amazon Comprehend Medical extracts structured information from unstructured clinical text.
• aws_compute_optimizer
  AWS Compute Optimizer is a service that analyzes the configuration and utilization metrics of your AWS compute resources, such as EC2 instances, Auto Scaling groups, AWS Lambda functions, and Amazon EBS volumes.
• aws_config
  AWS Config.
• aws_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.
• aws_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.
• aws_connectparticipant
  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.
• aws_cost_and_usage_report
  The AWS Cost and Usage Report API enables you to programmatically create, query, and delete AWS Cost and Usage report definitions.
• aws_cost_explorer
  The Cost Explorer API enables you to programmatically query your cost and usage data.
• aws_customer_profiles
  Amazon Connect Customer Profiles.
• aws_database_migration
  AWS Database Migration Service.
• aws_databrew
  AWS Glue DataBrew is a visual, cloud-scale data-preparation service.
• aws_dataexchange
  This is the API reference for AWS Data Exchange.
• aws_datapipeline
  AWS Data Pipeline configures and manages a data-driven workflow called a pipeline.
• aws_datasync
  AWS DataSync.
• aws_dax
  DAX is a managed caching service engineered for Amazon DynamoDB.
• aws_detective
  Detective uses machine learning and purpose-built visualizations to help you analyze and investigate security issues across your Amazon Web Services (AWS) workloads.
• aws_device_farm
  Welcome to the AWS Device Farm API documentation, which contains APIs for:.
• aws_devops_guru
  Amazon DevOps Guru is a fully managed service that helps you identify anomalous behavior in business critical operational applications.
• aws_direct_connect
  AWS Direct Connect links your internal network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable.
• aws_directory
  AWS Directory Service.
• aws_dlm
  Amazon Data Lifecycle Manager.
• aws_docdb
  Amazon DocumentDB API documentation.
• aws_dynamodb
  Amazon DynamoDB.
• aws_dynamodb_streams
  Amazon DynamoDB.
• aws_ebs
  You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create EBS snapshots, write data directly to your snapshots, read data on your snapshots, and identify the differences or changes between two snapshots.
• aws_ec2_instance_connect
  AWS EC2 Connect Service is a service that enables system administrators to publish temporary SSH keys to their EC2 instances in order to establish connections to their instances without leaving a permanent authentication option.
• aws_ecr
  Amazon Elastic Container Registry.
• aws_ecr_public
  Amazon Elastic Container Registry Public.
• aws_ecs
  Amazon Elastic Container Service.
• aws_efs
  Amazon Elastic File System.
• aws_eks
  Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on AWS without needing to stand up or maintain your own Kubernetes control plane.
• aws_elastic_beanstalk
  AWS Elastic Beanstalk.
• aws_elastic_inference
  Elastic Inference public APIs.
• aws_elastic_load_balancing
  Elastic Load Balancing.
• aws_elastic_load_balancing_v2
  Elastic Load Balancing.
• aws_elastic_transcoder
  AWS Elastic Transcoder Service.
• aws_elasticsearch
  Amazon Elasticsearch Configuration Service.
• aws_emr
  Amazon EMR is a web service that makes it easier to process large amounts of data efficiently.
• aws_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).
• aws_entitlement_marketplace
  AWS Marketplace Entitlement Service.
• aws_eventbridge
  Amazon EventBridge helps you to respond to state changes in your AWS resources.
• aws_firehose
  Amazon Kinesis Data Firehose API Reference.
• aws_fms
  AWS Firewall Manager.
• aws_forecastquery
  Provides APIs for creating and managing Amazon Forecast resources.
• aws_frauddetector
  This is the Amazon Fraud Detector API Reference.
• aws_fsx
  Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage.
• aws_gamelift
  Amazon GameLift Service.
• aws_glacier
  Amazon S3 Glacier (Glacier) is a storage solution for "cold data.".
• aws_global_accelerator
  AWS Global Accelerator.
• aws_glue
  AWS Glue.
• aws_greengrass
  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.
• aws_greengrassv2
  AWS IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities to edge devices.
• aws_groundstation
  Welcome to the AWS Ground Station API Reference.
• aws_guardduty
  Amazon GuardDuty is a continuous security monitoring service that analyzes and processes the following data sources: VPC Flow Logs, AWS CloudTrail event logs, and DNS logs.
• aws_health
  AWS Health.
• aws_healthlake
  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.
• aws_honeycode
  Amazon Honeycode is a fully managed service that allows you to quickly build mobile and web apps for teams—without programming.
• aws_iam
  AWS Identity and Access Management.
• aws_identitystore
• aws_imagebuilder
  EC2 Image Builder is a fully managed AWS 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_importexport
  AWS Import/Export Service.
• aws_inspector
  Amazon Inspector.
• aws_iot
  AWS IoT.
• aws_iot_1click_devices
  Describes all of the AWS IoT 1-Click device-related API operations for the service.
• aws_iot_1click_projects
  The AWS IoT 1-Click Projects API Reference.
• aws_iot_data_plane
  AWS IoT.
• aws_iot_events
  AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur.
• aws_iot_events_data
  AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur.
• aws_iot_jobs_data_plane
  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.
• aws_iot_wireless
  AWS IoT Wireless API documentation.
• aws_iotanalytics
  AWS IoT Analytics allows you to collect large amounts of device data, process messages, and store them.
• aws_iotdeviceadvisor
  AWS IoT Core Device Advisor is a cloud-based, fully managed test capability for validating IoT devices during device software development.
• aws_iotfleethub
  With Fleet Hub for AWS IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets.
• aws_iotsecuretunneling
  AWS IoT Secure Tunneling.
• aws_iotsitewise
  Welcome to the AWS IoT SiteWise API Reference.
• aws_iotthingsgraph
  AWS IoT Things Graph.
• aws_ivs
  Introduction.
• aws_kafka
  The operations for managing an Amazon MSK cluster.
• aws_kendra
  Amazon Kendra is a service for indexing large document sets.
• aws_kinesis
  Amazon Kinesis Data Streams Service API Reference.
• aws_kinesis_analytics
  Amazon Kinesis Analytics.
• aws_kinesis_analytics_v2
  Amazon Kinesis Data Analytics is a fully managed service that you can use to process and analyze streaming data using Java, SQL, or Scala.
• aws_kinesis_video
• aws_kinesis_video_archived_media
• aws_kinesis_video_media
• aws_kinesis_video_signaling
  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.
• aws_kms
  AWS Key Management Service.
• aws_lakeformation
  AWS Lake Formation.
• aws_lambda
  AWS Lambda.
• aws_lex_model_building
  Amazon Lex Build-Time Actions.
• aws_lex_models_v2
• aws_lex_runtime
  Amazon Lex provides both build and runtime endpoints.
• aws_lex_runtime_v2
• aws_license_manager
  AWS License Manager.
• aws_lightsail
  Amazon Lightsail is the easiest way to get started with Amazon Web Services (AWS) for developers who need to build websites or web applications.
• aws_location
  Suite of geospatial services including Maps, Places, Tracking, and Geofencing.
• aws_lookoutvision
  This is the Amazon Lookout for Vision API Reference.
• aws_machinelearning
  Definition of the public APIs exposed by Amazon Machine Learning.
• aws_macie
  Amazon Macie Classic.
• aws_macie2
  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.
• aws_managedblockchain
  .
• aws_marketplace_catalog
  Catalog API actions allow you to manage your entities through list, describe, and update capabilities.
• aws_marketplace_commerce_analytics
  Provides AWS Marketplace business intelligence data on-demand.
• aws_marketplace_metering
  AWS Marketplace Metering Service.
• aws_mediaconnect
  API for AWS Elemental MediaConnect.
• aws_mediaconvert
  AWS Elemental MediaConvert.
• aws_medialive
  API for AWS Elemental MediaLive.
• aws_mediapackage
  AWS Elemental MediaPackage.
• aws_mediapackage_vod
  AWS Elemental MediaPackage VOD.
• aws_mediastore
  An AWS Elemental MediaStore container is a namespace that holds folders and objects.
• aws_mediastore_data
  An AWS Elemental MediaStore asset is an object, similar to an object in the Amazon S3 service.
• aws_mediatailor
  Use the AWS Elemental MediaTailor SDK to configure scalable ad insertion for your live and VOD content.
• aws_migration_hub
  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.
• aws_migrationhub_config
  The AWS Migration Hub home region APIs are available specifically for working with your Migration Hub home region.
• aws_mobile
  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.
• aws_mobileanalytics
  Amazon Mobile Analytics is a service for collecting, visualizing, and understanding app usage data at scale.
• aws_mq
  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.
• aws_mturk
  Amazon Mechanical Turk API Reference.
• aws_mwaa
  Amazon Managed Workflows for Apache Airflow.
• aws_neptune
  Amazon Neptune.
• aws_network_firewall
  This is the API Reference for AWS Network Firewall.
• aws_networkmanager
  Transit Gateway Network Manager (Network Manager) enables you to create a global network, in which you can monitor your AWS and on-premises networks that are built around transit gateways.
• aws_opsworks
  AWS OpsWorks.
• aws_opsworkscm
  AWS OpsWorks CM.
• aws_organizations
  AWS Organizations.
• aws_outposts
  AWS Outposts is a fully managed service that extends AWS infrastructure, APIs, and tools to customer premises.
• aws_personalize
  Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers.
• aws_personalize_events
  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.
• aws_personalize_runtime
• aws_pi
  Amazon RDS Performance Insights.
• aws_pinpoint
  Doc Engage API - Amazon Pinpoint API.
• aws_pinpoint_email
  Amazon Pinpoint Email Service.
• aws_pinpoint_sms_voice
  Pinpoint SMS and Voice Messaging public facing APIs.
• aws_polly
  Amazon Polly is a web service that makes it easy to synthesize speech from text.
• aws_qldb
  The control plane for Amazon QLDB.
• aws_qldb_session
  The transactional data APIs for Amazon QLDB.
• aws_quicksight
  Amazon QuickSight API Reference.
• aws_ram
  Use AWS Resource Access Manager to share AWS resources between AWS accounts.
• aws_rds
  Amazon Relational Database Service.
• aws_rds_data
  Amazon RDS Data Service.
• aws_redshift
  Amazon Redshift.
• aws_redshift_data
  You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables.
• aws_rekognition
  This is the Amazon Rekognition API reference.
• aws_request
• aws_resource_groups
  AWS Resource Groups.
• aws_resource_groups_tagging_api
  Resource Groups Tagging API.
• aws_robomaker
  This section provides documentation for the AWS RoboMaker API operations.
• aws_route53
  Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service.
• aws_route53_domains
  Amazon Route 53 API actions let you register domain names and perform related operations.
• aws_route53resolver
  When you create a VPC using Amazon VPC, you automatically get DNS resolution within the VPC from Route 53 Resolver.
• aws_s3
• aws_s3_control
  AWS S3 Control provides access to Amazon S3 control plane operations.
• aws_s3outposts
  Amazon S3 on Outposts provides access to S3 on Outposts operations.
• aws_sagemaker
  Provides APIs for creating and managing Amazon SageMaker resources.
• aws_sagemaker_a2i_runtime
  Amazon Augmented AI is in preview release and is subject to change.
• aws_sagemaker_edge
  SageMaker Edge Manager dataplane service for communicating with active agents.
• aws_sagemaker_featurestore_runtime
  Contains all data plane API operations and data types for the Amazon SageMaker Feature Store.
• aws_sagemaker_runtime
  The Amazon SageMaker runtime API.
• aws_savingsplans
  Savings Plans are a pricing model that offer significant savings on AWS usage (for example, on Amazon EC2 instances).
• aws_schemas
  Amazon EventBridge Schema Registry.
• aws_sdb
  Amazon SimpleDB is a web service providing the core database functions of data indexing and querying in the cloud.
• aws_secrets_manager
  AWS Secrets Manager API Reference.
• aws_securityhub
  Security Hub provides you with a comprehensive view of the security state of your AWS environment and resources.
• aws_serverlessapplicationrepository
  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
  AWS Service Catalog.
• aws_service_catalog_appregistry
  AWS Service Catalog AppRegistry enables organizations to understand the application context of their AWS resources.
• aws_service_quotas
  With Service Quotas, you can view and manage your quotas easily as your AWS workloads grow.
• aws_servicediscovery
  AWS Cloud Map lets you configure public DNS, private DNS, or HTTP namespaces that your microservice applications run in.
• aws_ses
  Amazon Simple Email Service.
• aws_sesv2
  Amazon SES API v2.
• aws_sfn
  AWS Step Functions.
• aws_shield
  AWS Shield Advanced.
• aws_signer
  AWS Signer is a fully managed code signing service to help you ensure the trust and integrity of your code.
• aws_sms
  AWS Server Migration Service.
• aws_snowball
  AWS Snow Family is 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).
• aws_sns
  Amazon Simple Notification Service.
• aws_sqs
  Welcome to the Amazon Simple Queue Service API Reference.
• aws_ssm
  AWS Systems Manager.
• aws_sso
  AWS Single Sign-On Portal is a web service that makes it easy for you to assign user access to AWS SSO resources such as the user portal.
• aws_sso_admin
• aws_sso_oidc
  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.
• aws_storage_gateway
  AWS Storage Gateway Service.
• aws_sts
  AWS Security Token Service.
• aws_support
  AWS Support.
• aws_swf
  Amazon Simple Workflow Service.
• aws_synthetics
  Amazon CloudWatch Synthetics.
• aws_textract
  Amazon Textract detects and analyzes text in documents and converts it into machine-readable text.
• aws_timestream_query
• aws_timestream_write
  Amazon Timestream is a fast, scalable, fully managed time series database service that makes it easy to store and analyze trillions of time series data points per day.
• aws_transcribe
  Operations and objects for transcribing speech to text.
• aws_transcribe_streaming
  Operations and objects for transcribing streaming speech to text.
• aws_transfer
  AWS 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).
• aws_translate
  Provides translation between one source language and another of the same set of languages.
• aws_util
• aws_waf
  This is AWS WAF Classic documentation.
• aws_waf_regional
  This is AWS WAF Classic Regional documentation.
• aws_wafv2
  This is the latest version of the AWS WAF API, released in November, 2019.
• aws_wellarchitected
  AWS Well-Architected Tool.
• aws_workdocs
  The WorkDocs API is designed for the following use cases:.
• aws_worklink
  Amazon WorkLink is a cloud-based service that provides secure access to internal websites and web apps from iOS and Android phones.
• aws_workmail
  Amazon WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients.
• aws_workmailmessageflow
  The WorkMail Message Flow API provides access to email messages as they are being sent and received by a WorkMail organization.
• aws_workspaces
  Amazon WorkSpaces Service.
• aws_xray
  AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.