@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSCodeStarconnectionsClient extends AmazonWebServiceClient implements AWSCodeStarconnections
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
static AWSCodeStarconnectionsClientBuilder |
builder() |
CreateConnectionResult |
createConnection(CreateConnectionRequest request)
Creates a connection that can then be given to other AWS services like CodePipeline so that it can access
third-party code repositories.
|
DeleteConnectionResult |
deleteConnection(DeleteConnectionRequest request)
The connection to be deleted.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetConnectionResult |
getConnection(GetConnectionRequest request)
Returns the connection ARN and details such as status, owner, and provider type.
|
ListConnectionsResult |
listConnections(ListConnectionsRequest request)
Lists the connections associated with your account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds to or modifies the tags of the given resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes tags from an AWS resource.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitshutdownpublic static AWSCodeStarconnectionsClientBuilder builder()
public CreateConnectionResult createConnection(CreateConnectionRequest request)
Creates a connection that can then be given to other AWS services like CodePipeline so that it can access third-party code repositories. The connection is in pending status until the third-party connection handshake is completed from the console.
createConnection in interface AWSCodeStarconnectionscreateConnectionRequest - LimitExceededException - Exceeded the maximum limit for connections.public DeleteConnectionResult deleteConnection(DeleteConnectionRequest request)
The connection to be deleted.
deleteConnection in interface AWSCodeStarconnectionsdeleteConnectionRequest - ResourceNotFoundException - Resource not found. Verify the connection resource ARN and try again.public GetConnectionResult getConnection(GetConnectionRequest request)
Returns the connection ARN and details such as status, owner, and provider type.
getConnection in interface AWSCodeStarconnectionsgetConnectionRequest - ResourceNotFoundException - Resource not found. Verify the connection resource ARN and try again.public ListConnectionsResult listConnections(ListConnectionsRequest request)
Lists the connections associated with your account.
listConnections in interface AWSCodeStarconnectionslistConnectionsRequest - public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
listTagsForResource in interface AWSCodeStarconnectionslistTagsForResourceRequest - ResourceNotFoundException - Resource not found. Verify the connection resource ARN and try again.public TagResourceResult tagResource(TagResourceRequest request)
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
tagResource in interface AWSCodeStarconnectionstagResourceRequest - ResourceNotFoundException - Resource not found. Verify the connection resource ARN and try again.LimitExceededException - Exceeded the maximum limit for connections.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes tags from an AWS resource.
untagResource in interface AWSCodeStarconnectionsuntagResourceRequest - ResourceNotFoundException - Resource not found. Verify the connection resource ARN and try again.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AWSCodeStarconnectionsrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.