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. You can also query for granular data. This might include the number of daily write operations for Amazon DynamoDB database tables in your production environment.

Service Endpoint

The Cost Explorer API provides the following endpoint:

• https://ce.us-east-1.amazonaws.com

For information about the costs that are associated with the Cost Explorer API, see Amazon Web Services Cost Management Pricing.

The Amazon Chime application programming interface (API) is designed so administrators can perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes.

You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls for Amazon Chime. We recommend using an AWS SDK or the AWS CLI. The page for each API action contains a See Also section that includes links to information about using the action with a language-specific AWS SDK or the AWS CLI.

Using an AWS SDK

You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center.

Using the AWS CLI

Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLI Command Reference.

Using REST APIs

If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports Signature Version 4. For more information, see Signature Version 4 Signing Process in the Amazon Web Services General Reference.

When making REST API calls, use the service name chime and REST endpoint https://service.chime.aws.amazon.com.

Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Identity and Access Management for Amazon Chime in the Amazon Chime Administration Guide.

Cloud9

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

For more information about Cloud9, see the Cloud9 User Guide.

Cloud9 supports these operations:

• CreateEnvironmentEC2: Creates an Cloud9 development environment, launches an Amazon EC2 instance, and then connects from the instance to the environment.

• CreateEnvironmentMembership: Adds an environment member to an environment.

• DeleteEnvironment: Deletes an environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.

• DeleteEnvironmentMembership: Deletes an environment member from an environment.

• DescribeEnvironmentMemberships: Gets information about environment members for an environment.

• DescribeEnvironments: Gets information about environments.

• DescribeEnvironmentStatus: Gets status information for an environment.

• ListEnvironments: Gets a list of environment identifiers.

• ListTagsForResource: Gets the tags for an environment.

• TagResource: Adds tags to an environment.

• UntagResource: Removes tags from an environment.

• UpdateEnvironment: Changes the settings of an existing environment.

• UpdateEnvironmentMembership: Changes the settings of an existing environment member for an environment.

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 programmatically and includes detailed information on data types and errors. For information about Cloud Directory features, see AWS Directory Service and the Amazon Cloud Directory Developer Guide.

CloudFormation

CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and repeatedly. You can use CloudFormation to leverage Amazon Web Services 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 Amazon Web Services infrastructure.

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

For more information about CloudFormation, see the CloudFormation product page.

CloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a specific Amazon Web Services 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 CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the Amazon CloudFront Developer Guide.

AWS CloudHSM Service

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

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

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.

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 Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response elements returned by the service.

As an alternative to the API, you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools to Build on Amazon Web Services.

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

CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to share packages with development teams and pull packages. Packages can be pulled from both public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact repository and another repository, which effectively merges their contents from the point of view of a package manager client.

CodeArtifact Components

Use the information in this guide to help you work with the following CodeArtifact components:

• Repository: A CodeArtifact repository contains a set of package versions, each of which maps to a set of assets, or files. Repositories are polyglot, so a single repository can contain packages of any supported type. Each repository exposes endpoints for fetching and publishing packages using tools like the npm CLI, the Maven CLI ( mvn ), Python CLIs ( pip and twine), and NuGet CLIs (nuget and dotnet).

• Domain: Repositories are aggregated into a higher-level entity known as a domain. All package assets and metadata are stored in the domain, but are consumed through repositories. A given package asset, such as a Maven JAR file, is stored once per domain, no matter how many repositories it's present in. All of the assets and metadata in a domain are encrypted with the same customer master key (CMK) stored in Key Management Service (KMS).

  Each repository is a member of a single domain and can't be moved to a different domain.

  The domain allows organizational policy to be applied across multiple repositories, such as which accounts can access repositories in the domain, and which public repositories can be used as sources of packages.

  Although an organization can have multiple domains, we recommend a single production domain that contains all published artifacts so that teams can find and share packages across their organization.

• Package: A package is a bundle of software and the metadata required to resolve dependencies and install the software. CodeArtifact supports npm, PyPI, Maven, and NuGet package formats.

  In CodeArtifact, a package consists of:

  • A name (for example, webpack is the name of a popular npm package)

  • An optional namespace (for example, @types in @types/node)

  • A set of versions (for example, 1.0.0, 1.0.1, 1.0.2, etc.)

  • Package-level metadata (for example, npm tags)

• Package version: A version of a package, such as @types/node 12.6.9. The version number format and semantics vary for different package formats. For example, npm package versions must conform to the Semantic Versioning specification. In CodeArtifact, a package version consists of the version identifier, metadata at the package version level, and a set of assets.

• Upstream repository: One repository is upstream of another when the package versions in it can be accessed from the repository endpoint of the downstream repository, effectively merging the contents of the two repositories from the point of view of a client. CodeArtifact allows creating an upstream relationship between two repositories.

• Asset: An individual file stored in CodeArtifact associated with a package version, such as an npm .tgz file or Maven POM and JAR files.

CodeArtifact supports these operations:

• AssociateExternalConnection: Adds an existing external connection to a repository.

• CopyPackageVersions: Copies package versions from one repository to another repository in the same domain.

• CreateDomain: Creates a domain

• CreateRepository: Creates a CodeArtifact repository in a domain.

• DeleteDomain: Deletes a domain. You cannot delete a domain that contains repositories.

• DeleteDomainPermissionsPolicy: Deletes the resource policy that is set on a domain.

• DeletePackage: Deletes a package and all associated package versions.

• DeletePackageVersions: Deletes versions of a package. After a package has been deleted, it can be republished, but its assets and metadata cannot be restored because they have been permanently removed from storage.

• DeleteRepository: Deletes a repository.

• DeleteRepositoryPermissionsPolicy: Deletes the resource policy that is set on a repository.

• DescribeDomain: Returns a DomainDescription object that contains information about the requested domain.

• DescribePackage: Returns a PackageDescription object that contains details about a package.

• DescribePackageVersion: Returns a PackageVersionDescription object that contains details about a package version.

• DescribeRepository: Returns a RepositoryDescription object that contains detailed information about the requested repository.

• DisposePackageVersions: Disposes versions of a package. A package version with the status Disposed cannot be restored because they have been permanently removed from storage.

• DisassociateExternalConnection: Removes an existing external connection from a repository.

• GetAuthorizationToken: Generates a temporary authorization token for accessing repositories in the domain. The token expires the authorization period has passed. The default authorization period is 12 hours and can be customized to any length with a maximum of 12 hours.

• GetDomainPermissionsPolicy: Returns the policy of a resource that is attached to the specified domain.

• GetPackageVersionAsset: Returns the contents of an asset that is in a package version.

• GetPackageVersionReadme: Gets the readme file or descriptive text for a package version.

• GetRepositoryEndpoint: Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:

  • maven

  • npm

  • nuget

  • pypi

• GetRepositoryPermissionsPolicy: Returns the resource policy that is set on a repository.

• ListDomains: Returns a list of DomainSummary objects. Each returned DomainSummary object contains information about a domain.

• ListPackages: Lists the packages in a repository.

• ListPackageVersionAssets: Lists the assets for a given package version.

• ListPackageVersionDependencies: Returns a list of the direct dependencies for a package version.

• ListPackageVersions: Returns a list of package versions for a specified package in a repository.

• ListRepositories: Returns a list of repositories owned by the Amazon Web Services account that called this method.

• ListRepositoriesInDomain: Returns a list of the repositories in a domain.

• PublishPackageVersion: Creates a new package version containing one or more assets.

• PutDomainPermissionsPolicy: Attaches a resource policy to a domain.

• PutPackageOriginConfiguration: Sets the package origin configuration for a package, which determine how new versions of the package can be added to a specific repository.

• PutRepositoryPermissionsPolicy: Sets the resource policy on a repository that specifies permissions to access it.

• UpdatePackageVersionsStatus: Updates the status of one or more versions of a package.

• UpdateRepository: Updates the properties of a repository.

CodeBuild

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. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apache Maven, Gradle, and more. You can also fully customize build environments in CodeBuild to use your own build tools. CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about CodeBuild, see the CodeBuild User Guide.

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 can access it until you send them the new HTTPS or SSH URL to use.

Branches, by calling the following:

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

• DeleteBranch, which deletes the specified branch in a repository unless it is the default branch.

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

Files, by calling the following:

• DeleteFile, which deletes the content of a specified file from a specified branch.

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

• GetFile, which returns the base-64 encoded content of a specified file.

• GetFolder, which returns the contents of a specified folder or directory.

• PutFile, which adds or modifies a single file in a specified repository and branch.

Commits, by calling the following:

• BatchGetCommits, which returns information about one or more commits in a repository.

• CreateCommit, which creates a commit for changes to 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).

Merges, by calling the following:

• BatchDescribeMergeConflicts, which returns information about conflicts in a merge between commits in a repository.

• CreateUnreferencedMergeCommit, which creates an unreferenced commit between two branches or commits for the purpose of comparing them and identifying any potential conflicts.

• DescribeMergeConflicts, which returns information about merge conflicts between the base, source, and destination versions of a file in a potential merge.

• GetMergeCommit, which returns information about the merge between a source and destination commit.

• GetMergeConflicts, which returns information about merge conflicts between the source and destination branch in a pull request.

• GetMergeOptions, which returns information about the available merge options between two branches or commit specifiers.

• MergeBranchesByFastForward, which merges two branches using the fast-forward merge option.

• MergeBranchesBySquash, which merges two branches using the squash merge option.

• MergeBranchesByThreeWay, which merges two branches using the three-way merge option.

Pull requests, by calling the following:

• CreatePullRequest, which creates a pull request in a specified repository.

• CreatePullRequestApprovalRule, which creates an approval rule for a specified pull request.

• DeletePullRequestApprovalRule, which deletes an approval rule for a specified pull request.

• DescribePullRequestEvents, which returns information about one or more pull request events.

• EvaluatePullRequestApprovalRules, which evaluates whether a pull request has met all the conditions specified in its associated approval rules.

• GetCommentsForPullRequest, which returns information about comments on a specified pull request.

• GetPullRequest, which returns information about a specified pull request.

• GetPullRequestApprovalStates, which returns information about the approval states for a specified pull request.

• GetPullRequestOverrideState, which returns information about whether approval rules have been set aside (overriden) for a pull request, and if so, the Amazon Resource Name (ARN) of the user or identity that overrode the rules and their requirements for the pull request.

• ListPullRequests, which lists all pull requests for a repository.

• MergePullRequestByFastForward, which merges the source destination branch of a pull request into the specified destination branch for that pull request using the fast-forward merge option.

• MergePullRequestBySquash, which merges the source destination branch of a pull request into the specified destination branch for that pull request using the squash merge option.

• MergePullRequestByThreeWay. which merges the source destination branch of a pull request into the specified destination branch for that pull request using the three-way merge option.

• OverridePullRequestApprovalRules, which sets aside all approval rule requirements for a pull request.

• PostCommentForPullRequest, which posts a comment to a pull request at the specified line, file, or request.

• UpdatePullRequestApprovalRuleContent, which updates the structure of an approval rule for a pull request.

• UpdatePullRequestApprovalState, which updates the state of an approval on a pull request.

• UpdatePullRequestDescription, which updates the description of a pull request.

• UpdatePullRequestStatus, which updates the status of a pull request.

• UpdatePullRequestTitle, which updates the title of a pull request.

Approval rule templates, by calling the following:

• AssociateApprovalRuleTemplateWithRepository, which associates a template with a specified repository. After the template is associated with a repository, AWS CodeCommit creates approval rules that match the template conditions on every pull request created in the specified repository.

• BatchAssociateApprovalRuleTemplateWithRepositories, which associates a template with one or more specified repositories. After the template is associated with a repository, AWS CodeCommit creates approval rules that match the template conditions on every pull request created in the specified repositories.

• BatchDisassociateApprovalRuleTemplateFromRepositories, which removes the association between a template and specified repositories so that approval rules based on the template are not automatically created when pull requests are created in those repositories.

• CreateApprovalRuleTemplate, which creates a template for approval rules that can then be associated with one or more repositories in your AWS account.

• DeleteApprovalRuleTemplate, which deletes the specified template. It does not remove approval rules on pull requests already created with the template.

• DisassociateApprovalRuleTemplateFromRepository, which removes the association between a template and a repository so that approval rules based on the template are not automatically created when pull requests are created in the specified repository.

• GetApprovalRuleTemplate, which returns information about an approval rule template.

• ListApprovalRuleTemplates, which lists all approval rule templates in the AWS Region in your AWS account.

• ListAssociatedApprovalRuleTemplatesForRepository, which lists all approval rule templates that are associated with a specified repository.

• ListRepositoriesForApprovalRuleTemplate, which lists all repositories associated with the specified approval rule template.

• UpdateApprovalRuleTemplateDescription, which updates the description of an approval rule template.

• UpdateApprovalRuleTemplateName, which updates the name of an approval rule template.

• UpdateApprovalRuleTemplateContent, which updates the content of an approval rule template.

Comments in a repository, by calling the following:

• DeleteCommentContent, which deletes the content of a comment on a commit in a repository.

• GetComment, which returns information about a comment on a commit.

• GetCommentReactions, which returns information about emoji reactions to comments.

• GetCommentsForComparedCommit, which returns information about comments on the comparison between two commit specifiers in a repository.

• PostCommentForComparedCommit, which creates a comment on the comparison between two commit specifiers in a repository.

• PostCommentReply, which creates a reply to a comment.

• PutCommentReaction, which creates or updates an emoji reaction to a comment.

• UpdateComment, which updates the content of a comment on a commit in a repository.

Tags used to tag resources in AWS CodeCommit (not Git tags), by calling the following:

• ListTagsForResource, which gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeCommit.

• TagResource, which adds or updates tags for a resource in AWS CodeCommit.

• UntagResource, which removes tags for a resource in AWS CodeCommit.

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.

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

You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, updated applications in an Amazon ECS service, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use CodeDeploy.

CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.

CodeDeploy Components

Use the information in this guide to help you work with the following CodeDeploy components:

• Application: A name that uniquely identifies the application you want to deploy. CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.

• Deployment group: A set of individual instances, CodeDeploy Lambda deployment configuration settings, or an Amazon ECS service and network details. A Lambda deployment group specifies how to route traffic to a new version of a Lambda function. An Amazon ECS deployment group specifies the service created in Amazon ECS to deploy, a load balancer, and a listener to reroute production traffic to an updated containerized application. An Amazon EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Amazon EC2 Auto Scaling groups, or both. All deployment groups can specify optional trigger, alarm, and rollback settings.

• Deployment configuration: A set of deployment rules and deployment success and failure conditions used by CodeDeploy during a deployment.

• Deployment: The process and the components used when updating a Lambda function, a containerized application in an Amazon ECS service, or of installing content on one or more instances.

• Application revisions: For an Lambda deployment, this is an AppSpec file that specifies the Lambda function to be updated and one or more functions to validate deployment lifecycle events. For an Amazon ECS deployment, this is an AppSpec file that specifies the Amazon ECS task definition, container, and port where production traffic is rerouted. For an EC2/On-premises deployment, this is an archive file that contains source content—source code, webpages, executable files, and deployment scripts—along with an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.

This guide also contains information to help you get details about the instances in your deployments, to make on-premises instances available for CodeDeploy deployments, to get details about a Lambda function deployment, and to get details about Amazon ECS service deployments.

CodeDeploy Information Resources

• CodeDeploy User Guide

• CodeDeploy API Reference Guide

• CLI Reference for CodeDeploy

• CodeDeploy Developer Forum

This section provides documentation for the Amazon CodeGuru Reviewer API operations. 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.

By proactively detecting and providing recommendations for addressing code defects and implementing best practices, CodeGuru Reviewer improves the overall quality and maintainability of your code base during the code review stage. For more information about CodeGuru Reviewer, see the Amazon CodeGuru Reviewer User Guide.

To improve the security of your CodeGuru Reviewer API calls, you can establish a private connection between your VPC and CodeGuru Reviewer by creating an interface VPC endpoint. For more information, see CodeGuru Reviewer and interface VPC endpoints (Amazon Web Services PrivateLink) in the Amazon CodeGuru Reviewer User Guide.

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

Amazon CodeGuru Profiler collects runtime performance data from your live applications, and provides recommendations that can help you fine-tune your application performance. Using machine learning algorithms, CodeGuru Profiler can help you find your most expensive lines of code and suggest ways you can improve efficiency and remove CPU bottlenecks.

Amazon CodeGuru Profiler provides different visualizations of profiling data to help you identify what code is running on the CPU, see how much time is consumed, and suggest ways to reduce CPU utilization.

Amazon CodeGuru Profiler currently supports applications written in all Java virtual machine (JVM) languages and Python. While CodeGuru Profiler supports both visualizations and recommendations for applications written in Java, it can also generate visualizations and a subset of recommendations for applications written in other JVM languages and Python.

For more information, see What is Amazon CodeGuru Profiler in the Amazon CodeGuru Profiler User Guide.

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 can only be configured through the API. For more information, see the AWS CodePipeline User Guide.

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

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

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 the pipeline structure and pipeline metadata, including the pipeline Amazon Resource Name (ARN).

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

• ListActionExecutions, which returns action-level details for past executions. The details include full stage and action-level details, including individual action duration, status, any errors that occurred during the execution, and input and output artifact location details.

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

• ListPipelineExecutions, which gets a summary of the most recent executions for a pipeline.

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

• StopPipelineExecution, which stops the specified pipeline execution from continuing through the pipeline.

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

Pipelines include stages. Each stage contains one or more actions that must complete before the next stage begins. A stage results in success or failure. If a stage fails, the pipeline stops at that stage and remains stopped until either a new version of an artifact appears in the source location, or a user takes action to rerun 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, see AWS CodePipeline Pipeline Structure Reference.

Pipeline stages include actions that are categorized into categories such as source or build actions performed in 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. Valid action categories are:

• Source

• Build

• Test

• Deploy

• Approval

• Invoke

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. To integrate with AWS CodePipeline, developers 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 on.

• PutJobFailureResult, which provides details of a job failure.

• 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 on.

• PutThirdPartyJobFailureResult, which provides details of a job failure.

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

• DescribeProject, which lists the attributes of a project.

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

• ListResources, which lists the resources associated with a project.

• ListTagsForProject, which lists the tags associated with a project.

• TagProject, which adds tags to a project.

• UntagProject, which removes tags from a project.

• UpdateProject, which updates the attributes of a project.

Teams and team members, by calling the following:

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

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

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

• UpdateTeamMember, which updates a team member's attributes in a project.

Users, by calling the following:

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

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

• DescribeUserProfile, which describes the profile of a user.

• ListUserProfiles, which lists all user profiles.

• UpdateUserProfile, which updates the profile for a user.

AWS CodeStar Connections

This AWS CodeStar Connections API Reference provides descriptions and usage examples of the operations and data types for the AWS CodeStar Connections API. You can use the connections API to work with connections and installations.

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. For example, you can add the connection in CodePipeline so that it triggers your pipeline when a code change is made to your third-party code repository. Each connection is named and associated with a unique ARN that is used to reference the connection.

When you create a connection, the console initiates a third-party connection handshake. Installations are the apps that are used to conduct this handshake. For example, the installation for the Bitbucket provider type is the Bitbucket app. When you create a connection, you can choose an existing installation or create one.

When you want to create a connection to an installed provider type such as GitHub Enterprise Server, you create a host for your connections.

You can work with connections by calling:

• CreateConnection, which creates a uniquely named connection that can be referenced by services such as CodePipeline.

• DeleteConnection, which deletes the specified connection.

• GetConnection, which returns information about the connection, including the connection status.

• ListConnections, which lists the connections associated with your account.

You can work with hosts by calling:

• CreateHost, which creates a host that represents the infrastructure where your provider is installed.

• DeleteHost, which deletes the specified host.

• GetHost, which returns information about the host, including the setup status.

• ListHosts, which lists the hosts associated with your account.

You can work with tags in AWS CodeStar Connections by calling the following:

• ListTagsForResource, which gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeStar Connections.

• TagResource, which adds or updates tags for a resource in AWS CodeStar Connections.

• UntagResource, which removes tags for a resource in AWS CodeStar Connections.

For information about how to use AWS CodeStar Connections, see the Developer Tools User Guide.