AWS Certificate Manager

Welcome to the AWS Certificate Manager (ACM) API documentation.

You can use ACM to manage SSL/TLS certificates for your AWS-based websites and applications. For general information about using ACM, see the AWS Certificate Manager User Guide .

Amazon API Gateway

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. Amazon API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

Amazon AppStream 2.0

API documentation for Amazon AppStream 2.0.

With Application Auto Scaling, you can automatically scale your AWS resources. The experience similar to that of Auto Scaling. You can use Application Auto Scaling to accomplish the following tasks:

• Define scaling policies to automatically scale your AWS resources

• Scale your resources in response to CloudWatch alarms

• View the history of your scaling events

Application Auto Scaling can scale the following AWS resources:

• Amazon ECS services. For more information, see Service Auto Scaling in the Amazon EC2 Container Service Developer Guide.

• Amazon EC2 Spot fleets. For more information, see Automatic Scaling for Spot Fleet in the Amazon EC2 User Guide.

• Amazon EMR clusters. For more information, see Using Automatic Scaling in Amazon EMR in the Amazon EMR Management Guide.

• AppStream 2.0 fleets. For more information, see Autoscaling Amazon AppStream 2.0 Resources in the Amazon AppStream 2.0 Developer Guide.

For a list of supported regions, see AWS Regions and Endpoints: Application Auto Scaling in the AWS General Reference.

AWS Batch enables you to run batch computing workloads on the AWS Cloud. Batch computing is a common way for developers, scientists, and engineers to access large amounts of compute resources, and AWS Batch removes the undifferentiated heavy lifting of configuring and managing the required infrastructure. AWS Batch will be familiar to users of traditional batch computing software. This service can efficiently provision resources in response to jobs submitted in order to eliminate capacity constraints, reduce compute costs, and deliver results quickly.

As a fully managed service, AWS Batch enables developers, scientists, and engineers to run batch computing workloads of any scale. AWS Batch automatically provisions compute resources and optimizes the workload distribution based on the quantity and scale of the workloads. With AWS Batch, there is no need to install or manage batch computing software, which allows you to focus on analyzing results and solving problems. AWS Batch reduces operational complexities, saves time, and reduces costs, which makes it easy for developers, scientists, and engineers to run their batch jobs in the AWS Cloud.

All public APIs for AWS Budgets

Amazon Cloud Directory

Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile and IoT applications. This guide describes the Cloud Directory operations that you can call programatically and includes detailed information on data types and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.

AWS CloudFormation

AWS CloudFormation allows you to create and manage AWS infrastructure deployments predictably and repeatedly. You can use AWS CloudFormation to leverage AWS products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly scalable, cost-effective applications without creating or configuring the underlying AWS infrastructure.

With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.

For more information about AWS CloudFormation, see the AWS CloudFormation Product Page.

Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product's technical documentation at docs.aws.amazon.com.

Amazon CloudFront

This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about the CloudFront API actions, data types, and errors. For detailed information about CloudFront features and their associated API calls, see the Amazon CloudFront Developer Guide.

AWS CloudHSM Service

Amazon CloudSearch Configuration Service

You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.

The endpoint for configuration service requests is region-specific: cloudsearch.region.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.

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

The endpoints for submitting UploadDocuments, Search, and Suggest requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint.

For more information, see the Amazon CloudSearch Developer Guide.

AWS CloudTrail

This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.

CloudTrail is a web service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service.

See the AWS CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.

AWS CodeBuild

AWS CodeBuild is a fully managed build service in the cloud. AWS CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. AWS CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apach Maven, Gradle, and more. You can also fully customize build environments in AWS CodeBuild to use your own build tools. AWS CodeBuild scales automatically to meet peak build requests, and you pay only for the build time you consume. For more information about AWS CodeBuild, see the AWS CodeBuild User Guide.

AWS CodeBuild supports these operations:

• BatchGetProjects: Gets information about one or more build projects. A build project defines how AWS CodeBuild will run a build. This includes information such as where to get the source code to build, the build environment to use, the build commands to run, and where to store the build output. A build environment represents a combination of operating system, programming language runtime, and tools that AWS CodeBuild will use to run a build. Also, you can add tags to build projects to help manage your resources and costs.

• CreateProject: Creates a build project.

• DeleteProject: Deletes a build project.

• ListProjects: Gets a list of build project names, with each build project name representing a single build project.

• UpdateProject: Changes the settings of an existing build project.

• BatchGetBuilds: Gets information about one or more builds.

• ListBuilds: Gets a list of build IDs, with each build ID representing a single build.

• ListBuildsForProject: Gets a list of build IDs for the specified build project, with each build ID representing a single build.

• StartBuild: Starts running a build.

• StopBuild: Attempts to stop running a build.

• ListCuratedEnvironmentImages: Gets information about Docker images that are managed by AWS CodeBuild.

AWS CodeCommit

This is the AWS CodeCommit API Reference. This reference provides descriptions of the operations and data types for AWS CodeCommit API along with usage examples.

You can use the AWS CodeCommit API to work with the following objects:

Repositories, by calling the following:

• BatchGetRepositories, which returns information about one or more repositories associated with your AWS account

• CreateRepository, which creates an AWS CodeCommit repository

• DeleteRepository, which deletes an AWS CodeCommit repository

• GetRepository, which returns information about a specified repository

• ListRepositories, which lists all AWS CodeCommit repositories associated with your AWS account

• UpdateRepositoryDescription, which sets or updates the description of the repository

• UpdateRepositoryName, which changes the name of the repository. If you change the name of a repository, no other users of that repository will be able to access it until you send them the new HTTPS or SSH URL to use.

Branches, by calling the following:

• CreateBranch, which creates a new branch in a specified repository

• GetBranch, which returns information about a specified branch

• ListBranches, which lists all branches for a specified repository

• UpdateDefaultBranch, which changes the default branch for a repository

Information about committed code in a repository, by calling the following:

• GetBlob, which returns the base-64 encoded content of an individual Git blob object within a repository

• GetCommit, which returns information about a commit, including commit messages and author and committer information

• GetDifferences, which returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID or other fully qualified reference)

Triggers, by calling the following:

• GetRepositoryTriggers, which returns information about triggers configured for a repository

• PutRepositoryTriggers, which replaces all triggers for a repository and can be used to create or delete triggers

• TestRepositoryTriggers, which tests the functionality of a repository trigger by sending data to the trigger target

For information about how to use AWS CodeCommit, see the AWS CodeCommit User Guide.

AWS CodeDeploy

Overview

This reference guide provides descriptions of the AWS CodeDeploy APIs. For more information about AWS CodeDeploy, see the AWS CodeDeploy User Guide.

Using the APIs

You can use the AWS CodeDeploy APIs to work with the following:

• Applications are unique identifiers used by AWS CodeDeploy to ensure the correct combinations of revisions, deployment configurations, and deployment groups are being referenced during deployments.

  You can use the AWS CodeDeploy APIs to create, delete, get, list, and update applications.

• Deployment configurations are sets of deployment rules and success and failure conditions used by AWS CodeDeploy during deployments.

  You can use the AWS CodeDeploy APIs to create, delete, get, and list deployment configurations.

• Deployment groups are groups of instances to which application revisions can be deployed.

  You can use the AWS CodeDeploy APIs to create, delete, get, list, and update deployment groups.

• Instances represent Amazon EC2 instances to which application revisions are deployed. Instances are identified by their Amazon EC2 tags or Auto Scaling group names. Instances belong to deployment groups.

  You can use the AWS CodeDeploy APIs to get and list instance.

• Deployments represent the process of deploying revisions to instances.

  You can use the AWS CodeDeploy APIs to create, get, list, and stop deployments.

• Application revisions are archive files stored in Amazon S3 buckets or GitHub repositories. These revisions contain source content (such as source code, web pages, executable files, and deployment scripts) along with an application specification (AppSpec) file. (The AppSpec file is unique to AWS CodeDeploy; it defines the deployment actions you want AWS CodeDeploy to execute.) For application revisions stored in Amazon S3 buckets, an application revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For application revisions stored in GitHub repositories, an application revision is uniquely identified by its repository name and commit ID. Application revisions are deployed through deployment groups.

  You can use the AWS CodeDeploy APIs to get, list, and register application revisions.

AWS CodePipeline

Overview

This is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and data types for AWS CodePipeline. Some functionality for your pipeline is only configurable through the API. For additional information, see the AWS CodePipeline User Guide.

You can use the AWS CodePipeline API to work with pipelines, stages, actions, gates, and transitions, as described below.

Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of actions, gates, and stages.

You can work with pipelines by calling:

• CreatePipeline, which creates a uniquely-named pipeline.

• DeletePipeline, which deletes the specified pipeline.

• GetPipeline, which returns information about a pipeline structure.

• GetPipelineExecution, which returns information about a specific execution of a pipeline.

• GetPipelineState, which returns information about the current state of the stages and actions of a pipeline.

• ListPipelines, which gets a summary of all of the pipelines associated with your account.

• StartPipelineExecution, which runs the the most recent revision of an artifact through the pipeline.

• UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.

Pipelines include stages, which are logical groupings of gates and actions. Each stage contains one or more actions that must complete before the next stage begins. A stage will result in success or failure. If a stage fails, then the pipeline stops at that stage and will remain stopped until either a new version of an artifact appears in the source location, or a user takes action to re-run the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the status of stages in the pipeline, or GetPipeline, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, also refer to the AWS CodePipeline Pipeline Structure Reference.

Pipeline stages include actions, which are categorized into categories such as source or build actions performed within a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as CreatePipeline and GetPipelineState.

Pipelines also include transitions, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.

You can work with transitions by calling:

• DisableStageTransition, which prevents artifacts from transitioning to the next stage in a pipeline.

• EnableStageTransition, which enables transition of artifacts between stages in a pipeline.

Using the API to integrate with AWS CodePipeline

For third-party integrators or developers who want to create their own integrations with AWS CodePipeline, the expected sequence varies from the standard API user. In order to integrate with AWS CodePipeline, developers will need to work with the following items:

Jobs, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source.

You can work with jobs by calling:

• AcknowledgeJob, which confirms whether a job worker has received the specified job,

• GetJobDetails, which returns the details of a job,

• PollForJobs, which determines whether there are any jobs to act upon,

• PutJobFailureResult, which provides details of a job failure, and

• PutJobSuccessResult, which provides details of a job success.

Third party jobs, which are instances of an action created by a partner action and integrated into AWS CodePipeline. Partner actions are created by members of the AWS Partner Network.

You can work with third party jobs by calling:

• AcknowledgeThirdPartyJob, which confirms whether a job worker has received the specified job,

• GetThirdPartyJobDetails, which requests the details of a job for a partner action,

• PollForThirdPartyJobs, which determines whether there are any jobs to act upon,

• PutThirdPartyJobFailureResult, which provides details of a job failure, and

• PutThirdPartyJobSuccessResult, which provides details of a job success.

AWS CodeStar

This is the API reference for AWS CodeStar. This reference provides descriptions of the operations and data types for the AWS CodeStar API along with usage examples.

You can use the AWS CodeStar API to work with:

Projects and their resources, by calling the following:

• DeleteProject, which deletes a project in AWS CodeStar.

• DescribeProject, which lists the attributes of a project.

• ListProjects, which lists all AWS CodeStar projects associated with your AWS account.

• ListResources, which lists the resources associated with an AWS CodeStar project.

• UpdateProject, which updates the attributes of an AWS CodeStar project.

Teams and team members, by calling the following:

• AssociateTeamMember, which adds an IAM user to the team for an AWS CodeStar project.

• DisassociateTeamMember, which removes an IAM user from the team for an AWS CodeStar project.

• ListTeamMembers, which lists all the IAM users in the team for an AWS CodeStar project, including their roles and attributes.

Users, by calling the following:

• CreateUserProfile, which creates a user profile that contains data associated with the user across all AWS CodeStar projects.

• DeleteUserProfile, which deletes all user profile information across all AWS CodeStar projects.

• DescribeUserProfile, which describes the profile of a user.

• ListUserProfiles, which lists all AWS CodeStar user profiles.

• UpdateUserProfile, which updates the profile for an AWS CodeStar user.