[−][src]Crate rusoto_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 Cloud app. When you create a connection, you can choose an existing installation or create one.
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.
For information about how to use AWS CodeStar Connections, see the AWS CodePipeline User Guide.
If you're using the service, you're probably looking for CodeStarConnectionsClient and CodeStarConnections.
Structs
| CodeStarConnectionsClient | A client for the AWS CodeStar connections API. |
| Connection | The AWS::CodeStarConnections::Connection resource can be used to connect external source providers with services like AWS CodePipeline. Note: A connection created through CloudFormation is in `PENDING` status by default. You can make its status `AVAILABLE` by editing the connection in the CodePipeline console. |
| CreateConnectionInput | |
| CreateConnectionOutput | |
| DeleteConnectionInput | |
| DeleteConnectionOutput | |
| GetConnectionInput | |
| GetConnectionOutput | |
| ListConnectionsInput | |
| ListConnectionsOutput | |
| ListTagsForResourceInput | |
| ListTagsForResourceOutput | |
| Tag | A tag is a key-value pair that is used to manage the resource. This tag is available for use by AWS services that support tags. |
| TagResourceInput | |
| TagResourceOutput | |
| UntagResourceInput | |
| UntagResourceOutput |
Enums
| CreateConnectionError | Errors returned by CreateConnection |
| DeleteConnectionError | Errors returned by DeleteConnection |
| GetConnectionError | Errors returned by GetConnection |
| ListConnectionsError | Errors returned by ListConnections |
| ListTagsForResourceError | Errors returned by ListTagsForResource |
| TagResourceError | Errors returned by TagResource |
| UntagResourceError | Errors returned by UntagResource |
Traits
| CodeStarConnections | Trait representing the capabilities of the AWS CodeStar connections API. AWS CodeStar connections clients implement this trait. |