com.amazonaws.services.codecommit

Class AWSCodeCommitClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.codecommit.AWSCodeCommitClient

All Implemented Interfaces:

AWSCodeCommit

Direct Known Subclasses:

AWSCodeCommitAsyncClient

public class AWSCodeCommitClient
extends AmazonWebServiceClient
implements AWSCodeCommit

Client for accessing CodeCommit. All service calls made using this client are blocking, and will not return until the service call completes.

AWS CodeCommit

This is the AWS CodeCommit API Reference. This reference provides descriptions of the AWS CodeCommit API.

You can use the AWS CodeCommit API to work with the following objects:

• Repositories
• Branches
• Commits

For information about how to use AWS CodeCommit, see the AWS CodeCommit User Guide.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.JsonErrorUnmarshallerV2>	jsonErrorUnmarshallers List of exception unmarshallers for all CodeCommit exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AWSCodeCommitClient() Constructs a new client to invoke service methods on CodeCommit.
AWSCodeCommitClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on CodeCommit using the specified AWS account credentials.
AWSCodeCommitClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on CodeCommit using the specified AWS account credentials and client configuration options.
AWSCodeCommitClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on CodeCommit using the specified AWS account credentials provider.
AWSCodeCommitClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on CodeCommit using the specified AWS account credentials provider and client configuration options.
AWSCodeCommitClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on CodeCommit using the specified AWS account credentials provider, client configuration options, and request metric collector.
AWSCodeCommitClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on CodeCommit.

Method Summary

Methods

Modifier and Type	Method and Description
BatchGetRepositoriesResult	batchGetRepositories(BatchGetRepositoriesRequest batchGetRepositoriesRequest) Gets information about one or more repositories.
void	createBranch(CreateBranchRequest createBranchRequest) Creates a new branch in a repository and points the branch to a commit.
CreateRepositoryResult	createRepository(CreateRepositoryRequest createRepositoryRequest) Creates a new, empty repository.
DeleteRepositoryResult	deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest) Deletes a repository.
GetBranchResult	getBranch(GetBranchRequest getBranchRequest) Retrieves information about a repository branch, including its name and the last commit ID.
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.
GetRepositoryResult	getRepository(GetRepositoryRequest getRepositoryRequest) Gets information about a repository.
ListBranchesResult	listBranches(ListBranchesRequest listBranchesRequest) Gets information about one or more branches in a repository.
ListRepositoriesResult	listRepositories(ListRepositoriesRequest listRepositoriesRequest) Gets information about one or more repositories.
void	updateDefaultBranch(UpdateDefaultBranchRequest updateDefaultBranchRequest) Sets or changes the default branch name for the specified repository.
void	updateRepositoryDescription(UpdateRepositoryDescriptionRequest updateRepositoryDescriptionRequest) Sets or changes the comment or description for a repository.
void	updateRepositoryName(UpdateRepositoryNameRequest updateRepositoryNameRequest) Renames a repository.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.codecommit.AWSCodeCommit

setEndpoint, setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected List<com.amazonaws.transform.JsonErrorUnmarshallerV2> jsonErrorUnmarshallers

List of exception unmarshallers for all CodeCommit exceptions.

Constructor Detail

AWSCodeCommitClient

public AWSCodeCommitClient()

Constructs a new client to invoke service methods on CodeCommit. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSCodeCommitClient

public AWSCodeCommitClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on CodeCommit. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to CodeCommit (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSCodeCommitClient

public AWSCodeCommitClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on CodeCommit using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSCodeCommitClient

public AWSCodeCommitClient(AWSCredentials awsCredentials,
                   ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on CodeCommit using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to CodeCommit (ex: proxy settings, retry counts, etc.).

AWSCodeCommitClient

public AWSCodeCommitClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on CodeCommit using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSCodeCommitClient

public AWSCodeCommitClient(AWSCredentialsProvider awsCredentialsProvider,
                   ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on CodeCommit using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to CodeCommit (ex: proxy settings, retry counts, etc.).

AWSCodeCommitClient

public AWSCodeCommitClient(AWSCredentialsProvider awsCredentialsProvider,
                   ClientConfiguration clientConfiguration,
                   RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on CodeCommit using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to CodeCommit (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

batchGetRepositories

public BatchGetRepositoriesResult batchGetRepositories(BatchGetRepositoriesRequest batchGetRepositoriesRequest)

Gets information about one or more repositories.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page.

Specified by:

batchGetRepositories in interface AWSCodeCommit

Parameters:

batchGetRepositoriesRequest - Represents the input of a batch get repositories operation.

Returns:

Result of the BatchGetRepositories operation returned by the service.

Throws:

RepositoryNamesRequiredException - A repository names object is required but was not specified.

MaximumRepositoryNamesExceededException - The maximum number of allowed repository names was exceeded. Currently, this number is 25.

InvalidRepositoryNameException - At least one specified repository name is not valid.

This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.

EncryptionIntegrityChecksFailedException - An encryption integrity check failed.

EncryptionKeyAccessDeniedException - An encryption key could not be accessed.

EncryptionKeyDisabledException - The encryption key is disabled.

EncryptionKeyNotFoundException - No encryption key was found.

EncryptionKeyUnavailableException - The encryption key is not available.

createBranch

public void createBranch(CreateBranchRequest createBranchRequest)

Creates a new branch in a repository and points the branch to a commit.

Calling the create branch operation does not set a repository's default branch. To do this, call the update default branch operation.

Specified by:

createBranch in interface AWSCodeCommit

Parameters:

createBranchRequest - Represents the input of a create branch operation.

Throws:

RepositoryNameRequiredException - A repository name is required but was not specified.

InvalidRepositoryNameException - At least one specified repository name is not valid.

This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.

RepositoryDoesNotExistException - The specified repository does not exist.

BranchNameRequiredException - A branch name is required but was not specified.

BranchNameExistsException - The specified branch name already exists.

InvalidBranchNameException - The specified branch name is not valid.

CommitIdRequiredException - A commit ID was not specified.

CommitDoesNotExistException - The specified commit does not exist or no commit was specified, and the specified repository has no default branch.

InvalidCommitIdException - The specified commit ID is not valid.

EncryptionIntegrityChecksFailedException - An encryption integrity check failed.

EncryptionKeyAccessDeniedException - An encryption key could not be accessed.

EncryptionKeyDisabledException - The encryption key is disabled.

EncryptionKeyNotFoundException - No encryption key was found.

EncryptionKeyUnavailableException - The encryption key is not available.

createRepository

public CreateRepositoryResult createRepository(CreateRepositoryRequest createRepositoryRequest)

Creates a new, empty repository.

Specified by:

createRepository in interface AWSCodeCommit

Parameters:

createRepositoryRequest - Represents the input of a create repository operation.

Returns:

Result of the CreateRepository operation returned by the service.

Throws:

RepositoryNameExistsException - The specified repository name already exists.

RepositoryNameRequiredException - A repository name is required but was not specified.

InvalidRepositoryNameException - At least one specified repository name is not valid.

This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.

InvalidRepositoryDescriptionException - The specified repository description is not valid.

RepositoryLimitExceededException - A repository resource limit was exceeded.

EncryptionIntegrityChecksFailedException - An encryption integrity check failed.

EncryptionKeyAccessDeniedException - An encryption key could not be accessed.

EncryptionKeyDisabledException - The encryption key is disabled.

EncryptionKeyNotFoundException - No encryption key was found.

EncryptionKeyUnavailableException - The encryption key is not available.

deleteRepository

public DeleteRepositoryResult deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest)

Deletes a repository. If a specified repository was already deleted, a null repository ID will be returned.

Deleting a repository also deletes all associated objects and metadata. After a repository is deleted, all future push calls to the deleted repository will fail.

Specified by:

deleteRepository in interface AWSCodeCommit

Parameters:

deleteRepositoryRequest - Represents the input of a delete repository operation.

Returns:

Result of the DeleteRepository operation returned by the service.

Throws:

RepositoryNameRequiredException - A repository name is required but was not specified.

InvalidRepositoryNameException - At least one specified repository name is not valid.

This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.

EncryptionIntegrityChecksFailedException - An encryption integrity check failed.

EncryptionKeyAccessDeniedException - An encryption key could not be accessed.

EncryptionKeyDisabledException - The encryption key is disabled.

EncryptionKeyNotFoundException - No encryption key was found.

EncryptionKeyUnavailableException - The encryption key is not available.

getBranch

public GetBranchResult getBranch(GetBranchRequest getBranchRequest)

Retrieves information about a repository branch, including its name and the last commit ID.

Specified by:

getBranch in interface AWSCodeCommit

Parameters:

getBranchRequest - Represents the input of a get branch operation.

Returns:

Result of the GetBranch operation returned by the service.

Throws:

RepositoryNameRequiredException - A repository name is required but was not specified.

RepositoryDoesNotExistException - The specified repository does not exist.

InvalidRepositoryNameException - At least one specified repository name is not valid.

This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.

BranchNameRequiredException - A branch name is required but was not specified.

InvalidBranchNameException - The specified branch name is not valid.

BranchDoesNotExistException - The specified branch does not exist.

EncryptionIntegrityChecksFailedException - An encryption integrity check failed.

EncryptionKeyAccessDeniedException - An encryption key could not be accessed.

EncryptionKeyDisabledException - The encryption key is disabled.

EncryptionKeyNotFoundException - No encryption key was found.

EncryptionKeyUnavailableException - The encryption key is not available.

getRepository

public GetRepositoryResult getRepository(GetRepositoryRequest getRepositoryRequest)

Gets information about a repository.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page.

Specified by:

getRepository in interface AWSCodeCommit

Parameters:

getRepositoryRequest - Represents the input of a get repository operation.

Returns:

Result of the GetRepository operation returned by the service.

Throws:

RepositoryNameRequiredException - A repository name is required but was not specified.

RepositoryDoesNotExistException - The specified repository does not exist.

InvalidRepositoryNameException - At least one specified repository name is not valid.

This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.

EncryptionIntegrityChecksFailedException - An encryption integrity check failed.

EncryptionKeyAccessDeniedException - An encryption key could not be accessed.

EncryptionKeyDisabledException - The encryption key is disabled.

EncryptionKeyNotFoundException - No encryption key was found.

EncryptionKeyUnavailableException - The encryption key is not available.

listBranches

public ListBranchesResult listBranches(ListBranchesRequest listBranchesRequest)

Gets information about one or more branches in a repository.

Specified by:

listBranches in interface AWSCodeCommit

Parameters:

listBranchesRequest - Represents the input of a list branches operation.

Returns:

Result of the ListBranches operation returned by the service.

Throws:

RepositoryNameRequiredException - A repository name is required but was not specified.

RepositoryDoesNotExistException - The specified repository does not exist.

InvalidRepositoryNameException - At least one specified repository name is not valid.

This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.

EncryptionIntegrityChecksFailedException - An encryption integrity check failed.

EncryptionKeyAccessDeniedException - An encryption key could not be accessed.

EncryptionKeyDisabledException - The encryption key is disabled.

EncryptionKeyNotFoundException - No encryption key was found.

EncryptionKeyUnavailableException - The encryption key is not available.

InvalidContinuationTokenException - The specified continuation token is not valid.

listRepositories

public ListRepositoriesResult listRepositories(ListRepositoriesRequest listRepositoriesRequest)

Gets information about one or more repositories.

Specified by:

listRepositories in interface AWSCodeCommit

Parameters:

listRepositoriesRequest - Represents the input of a list repositories operation.

Returns:

Result of the ListRepositories operation returned by the service.

Throws:

InvalidSortByException - The specified sort by value is not valid.

InvalidOrderException - The specified sort order is not valid.

InvalidContinuationTokenException - The specified continuation token is not valid.

updateDefaultBranch

public void updateDefaultBranch(UpdateDefaultBranchRequest updateDefaultBranchRequest)

Sets or changes the default branch name for the specified repository.

If you use this operation to change the default branch name to the current default branch name, a success message is returned even though the default branch did not change.

Specified by:

updateDefaultBranch in interface AWSCodeCommit

Parameters:

updateDefaultBranchRequest - Represents the input of an update default branch operation.

Throws:

RepositoryNameRequiredException - A repository name is required but was not specified.

RepositoryDoesNotExistException - The specified repository does not exist.

InvalidRepositoryNameException - At least one specified repository name is not valid.

This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.

BranchNameRequiredException - A branch name is required but was not specified.

InvalidBranchNameException - The specified branch name is not valid.

BranchDoesNotExistException - The specified branch does not exist.

EncryptionIntegrityChecksFailedException - An encryption integrity check failed.

EncryptionKeyAccessDeniedException - An encryption key could not be accessed.

EncryptionKeyDisabledException - The encryption key is disabled.

EncryptionKeyNotFoundException - No encryption key was found.

EncryptionKeyUnavailableException - The encryption key is not available.

updateRepositoryDescription

public void updateRepositoryDescription(UpdateRepositoryDescriptionRequest updateRepositoryDescriptionRequest)

Sets or changes the comment or description for a repository.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page.

Specified by:

updateRepositoryDescription in interface AWSCodeCommit

Parameters:

updateRepositoryDescriptionRequest - Represents the input of an update repository description operation.

Throws:

RepositoryNameRequiredException - A repository name is required but was not specified.

RepositoryDoesNotExistException - The specified repository does not exist.

InvalidRepositoryNameException - At least one specified repository name is not valid.

This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.

InvalidRepositoryDescriptionException - The specified repository description is not valid.

EncryptionIntegrityChecksFailedException - An encryption integrity check failed.

EncryptionKeyAccessDeniedException - An encryption key could not be accessed.

EncryptionKeyDisabledException - The encryption key is disabled.

EncryptionKeyNotFoundException - No encryption key was found.

EncryptionKeyUnavailableException - The encryption key is not available.

updateRepositoryName

public void updateRepositoryName(UpdateRepositoryNameRequest updateRepositoryNameRequest)

Renames a repository.

Specified by:

updateRepositoryName in interface AWSCodeCommit

Parameters:

updateRepositoryNameRequest - Represents the input of an update repository description operation.

Throws:

RepositoryDoesNotExistException - The specified repository does not exist.

RepositoryNameExistsException - The specified repository name already exists.

RepositoryNameRequiredException - A repository name is required but was not specified.

InvalidRepositoryNameException - At least one specified repository name is not valid.

This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSCodeCommit

Parameters:

request - The originally executed request

Returns:

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