Amazon Web Services, Inc.

AWS CodeStar connections

AWS CodeStar Connections This Amazon Web Services CodeStar Connections API Reference provides descriptions and usage examples of the operations and data types…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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

Connections are configurations that you use to connect Amazon Web Services
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 Amazon Web Services CodeStar Connections by calling the following:

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

TagResource , which adds or updates tags for a resource in Amazon Web Services CodeStar
Connections.

UntagResource , which removes tags for a resource in Amazon Web Services CodeStar
Connections.

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

Endpoints 27

  • POSTCreate connection/#X-Amz-Target=CodeStar_connections_20191201.CreateConnectionCreates a connection that can then be given to other Amazon Web Services services like CodePipeline so that it can access third-party code repositories. The…
  • POSTCreate host/#X-Amz-Target=CodeStar_connections_20191201.CreateHostCreates a resource that represents the infrastructure where a third-party provider is installed. The host is used when you create connections to an installed…
  • POSTCreate repository link/#X-Amz-Target=CodeStar_connections_20191201.CreateRepositoryLinkCreates a link to a specified external Git repository. A repository link allows Git sync to monitor and sync changes to files in a specified Git repository.
  • POSTCreate sync configuration/#X-Amz-Target=CodeStar_connections_20191201.CreateSyncConfigurationCreates a sync configuration which allows Amazon Web Services to sync content from a Git repository to update a specified Amazon Web Services resource.…
  • POSTDelete connection/#X-Amz-Target=CodeStar_connections_20191201.DeleteConnectionThe connection to be deleted.
  • POSTDelete host/#X-Amz-Target=CodeStar_connections_20191201.DeleteHostThe host to be deleted. Before you delete a host, all connections associated to the host must be deleted. A host cannot be deleted if it is in the…
  • POSTDelete repository link/#X-Amz-Target=CodeStar_connections_20191201.DeleteRepositoryLinkDeletes the association between your connection and a specified external Git repository.
  • POSTDelete sync configuration/#X-Amz-Target=CodeStar_connections_20191201.DeleteSyncConfigurationDeletes the sync configuration for a specified repository and connection.
  • POSTGet connection/#X-Amz-Target=CodeStar_connections_20191201.GetConnectionReturns the connection ARN and details such as status, owner, and provider type.
  • POSTGet host/#X-Amz-Target=CodeStar_connections_20191201.GetHostReturns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration.
  • POSTGet repository link/#X-Amz-Target=CodeStar_connections_20191201.GetRepositoryLinkReturns details about a repository link. A repository link allows Git sync to monitor and sync changes from files in a specified Git repository.
  • POSTGet repository sync status/#X-Amz-Target=CodeStar_connections_20191201.GetRepositorySyncStatusReturns details about the sync status for a repository. A repository sync uses Git sync to push and pull changes from your remote repository.
  • POSTGet resource sync status/#X-Amz-Target=CodeStar_connections_20191201.GetResourceSyncStatusReturns the status of the sync with the Git repository for a specific Amazon Web Services resource.
  • POSTGet sync blocker summary/#X-Amz-Target=CodeStar_connections_20191201.GetSyncBlockerSummaryReturns a list of the most recent sync blockers.
  • POSTGet sync configuration/#X-Amz-Target=CodeStar_connections_20191201.GetSyncConfigurationReturns details about a sync configuration, including the sync type and resource name. A sync configuration allows the configuration to sync (push and pull)…
  • POSTList connections/#X-Amz-Target=CodeStar_connections_20191201.ListConnectionsLists the connections associated with your account.
  • POSTList hosts/#X-Amz-Target=CodeStar_connections_20191201.ListHostsLists the hosts associated with your account.
  • POSTList repository links/#X-Amz-Target=CodeStar_connections_20191201.ListRepositoryLinksLists the repository links created for connections in your account.
  • POSTList repository sync definitions/#X-Amz-Target=CodeStar_connections_20191201.ListRepositorySyncDefinitionsLists the repository sync definitions for repository links in your account.
  • POSTList sync configurations/#X-Amz-Target=CodeStar_connections_20191201.ListSyncConfigurationsReturns a list of sync configurations for a specified repository.
  • POSTList tags for resource/#X-Amz-Target=CodeStar_connections_20191201.ListTagsForResourceGets the set of key-value pairs (metadata) that are used to manage the resource.
  • POSTTag resource/#X-Amz-Target=CodeStar_connections_20191201.TagResourceAdds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
  • POSTUntag resource/#X-Amz-Target=CodeStar_connections_20191201.UntagResourceRemoves tags from an Amazon Web Services resource.
  • POSTUpdate host/#X-Amz-Target=CodeStar_connections_20191201.UpdateHostUpdates a specified host with the provided configurations.
  • POSTUpdate repository link/#X-Amz-Target=CodeStar_connections_20191201.UpdateRepositoryLinkUpdates the association between your connection and a specified external Git repository. A repository link allows Git sync to monitor and sync changes to…
  • POSTUpdate sync blocker/#X-Amz-Target=CodeStar_connections_20191201.UpdateSyncBlockerAllows you to update the status of a sync blocker, resolving the blocker and allowing syncing to continue.
  • POSTUpdate sync configuration/#X-Amz-Target=CodeStar_connections_20191201.UpdateSyncConfigurationUpdates the sync configuration for your connection and a specified external Git repository.

API details

Base URL
https://codestar-connections.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
27 operations on 27 pathsPOST 27
Description format
AWS Smithy model, API version 2019-12-01

How to test the AWS CodeStar connections in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS CodeStar connections collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create connection” (POST /#X-Amz-Target=CodeStar_connections_20191201.CreateConnection), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS CodeStar connections?

AWS CodeStar Connections This Amazon Web Services CodeStar Connections API Reference provides descriptions and usage examples of the operations and data types… It is listed under Developer tools and has 27 endpoints.

Who publishes the AWS CodeStar connections?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS CodeStar connections?

Requests go to https://codestar-connections.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS CodeStar connections?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS CodeStar connections have?

27 operations on 27 paths (27 POST).

Is forking the AWS CodeStar connections free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.