com.amazonaws.services.codestarconnections

Interface AWSCodeStarconnections

All Known Subinterfaces:

AWSCodeStarconnectionsAsync

All Known Implementing Classes:

AbstractAWSCodeStarconnections, AbstractAWSCodeStarconnectionsAsync, AWSCodeStarconnectionsAsyncClient, AWSCodeStarconnectionsClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSCodeStarconnections

Interface for accessing AWS CodeStar connections.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSCodeStarconnections instead.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateConnectionResult	createConnection(CreateConnectionRequest createConnectionRequest) Creates a connection that can then be given to other AWS services like CodePipeline so that it can access third-party code repositories.
CreateHostResult	createHost(CreateHostRequest createHostRequest) Creates a resource that represents the infrastructure where a third-party provider is installed.
DeleteConnectionResult	deleteConnection(DeleteConnectionRequest deleteConnectionRequest) The connection to be deleted.
DeleteHostResult	deleteHost(DeleteHostRequest deleteHostRequest) The host 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 getConnectionRequest) Returns the connection ARN and details such as status, owner, and provider type.
GetHostResult	getHost(GetHostRequest getHostRequest) Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration.
ListConnectionsResult	listConnections(ListConnectionsRequest listConnectionsRequest) Lists the connections associated with your account.
ListHostsResult	listHosts(ListHostsRequest listHostsRequest) Lists the hosts associated with your account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Gets the set of key-value pairs (metadata) that are used to manage the resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds to or modifies the tags of the given resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes tags from an AWS resource.
UpdateHostResult	updateHost(UpdateHostRequest updateHostRequest) Updates a specified host with the provided configurations.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createConnection

CreateConnectionResult createConnection(CreateConnectionRequest createConnectionRequest)

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.

Parameters:

createConnectionRequest -

Returns:

Result of the CreateConnection operation returned by the service.

Throws:

LimitExceededException - Exceeded the maximum limit for connections.

ResourceNotFoundException - Resource not found. Verify the connection resource ARN and try again.

ResourceUnavailableException - Resource not found. Verify the ARN for the host resource and try again.

See Also:

AWS API Documentation

createHost

CreateHostResult createHost(CreateHostRequest createHostRequest)

Creates a resource that represents the infrastructure where a third-party provider is installed. The host is used when you create connections to an installed third-party provider type, such as GitHub Enterprise Server. You create one host for all connections to that provider.

A host created through the CLI or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` by setting up the host in the console.

Parameters:

createHostRequest -

Returns:

Result of the CreateHost operation returned by the service.

Throws:

LimitExceededException - Exceeded the maximum limit for connections.

See Also:

AWS API Documentation

deleteConnection

DeleteConnectionResult deleteConnection(DeleteConnectionRequest deleteConnectionRequest)

The connection to be deleted.

Parameters:

deleteConnectionRequest -

Returns:

Result of the DeleteConnection operation returned by the service.

Throws:

ResourceNotFoundException - Resource not found. Verify the connection resource ARN and try again.

See Also:

AWS API Documentation

deleteHost

DeleteHostResult deleteHost(DeleteHostRequest deleteHostRequest)

The 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 VPC_CONFIG_INITIALIZING or VPC_CONFIG_DELETING state.

Parameters:

deleteHostRequest -

Returns:

Result of the DeleteHost operation returned by the service.

Throws:

ResourceNotFoundException - Resource not found. Verify the connection resource ARN and try again.

ResourceUnavailableException - Resource not found. Verify the ARN for the host resource and try again.

See Also:

AWS API Documentation

getConnection

GetConnectionResult getConnection(GetConnectionRequest getConnectionRequest)

Returns the connection ARN and details such as status, owner, and provider type.

Parameters:

getConnectionRequest -

Returns:

Result of the GetConnection operation returned by the service.

Throws:

ResourceNotFoundException - Resource not found. Verify the connection resource ARN and try again.

ResourceUnavailableException - Resource not found. Verify the ARN for the host resource and try again.

See Also:

AWS API Documentation

getHost

GetHostResult getHost(GetHostRequest getHostRequest)

Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration.

Parameters:

getHostRequest -

Returns:

Result of the GetHost operation returned by the service.

Throws:

ResourceNotFoundException - Resource not found. Verify the connection resource ARN and try again.

ResourceUnavailableException - Resource not found. Verify the ARN for the host resource and try again.

See Also:

AWS API Documentation

listConnections

ListConnectionsResult listConnections(ListConnectionsRequest listConnectionsRequest)

Lists the connections associated with your account.

Parameters:

listConnectionsRequest -

Returns:

Result of the ListConnections operation returned by the service.

See Also:

AWS API Documentation

listHosts

ListHostsResult listHosts(ListHostsRequest listHostsRequest)

Lists the hosts associated with your account.

Parameters:

listHostsRequest -

Returns:

Result of the ListHosts operation returned by the service.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Gets the set of key-value pairs (metadata) that are used to manage the resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException - Resource not found. Verify the connection resource ARN and try again.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ResourceNotFoundException - Resource not found. Verify the connection resource ARN and try again.

LimitExceededException - Exceeded the maximum limit for connections.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes tags from an AWS resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ResourceNotFoundException - Resource not found. Verify the connection resource ARN and try again.

See Also:

AWS API Documentation

updateHost

UpdateHostResult updateHost(UpdateHostRequest updateHostRequest)

Updates a specified host with the provided configurations.

Parameters:

updateHostRequest -

Returns:

Result of the UpdateHost operation returned by the service.

Throws:

ConflictException - Two conflicting operations have been made on the same resource.

ResourceNotFoundException - Resource not found. Verify the connection resource ARN and try again.

ResourceUnavailableException - Resource not found. Verify the ARN for the host resource and try again.

UnsupportedOperationException - The operation is not supported. Check the connection status and try again.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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 a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.