/
doc.go
51 lines (50 loc) · 2.98 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
// Code generated by smithy-go-codegen DO NOT EDIT.
// Package codestarconnections provides the API client, operations, and parameter
// types for 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 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 (https://docs.aws.amazon.com/dtconsole/latest/userguide/welcome-connections.html)
// .
package codestarconnections