Network.AWS.CodeCommit

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/.

See: AWS API Reference

Service Configuration

codeCommit :: Service

API version '2015-04-13' of the Amazon CodeCommit SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by CodeCommit.

InvalidContinuationTokenException

_InvalidContinuationTokenException :: AsError a => Getting (First ServiceError) a ServiceError

The specified continuation token is not valid.

EncryptionKeyNotFoundException

_EncryptionKeyNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError

No encryption key was found.

MaximumRepositoryNamesExceededException

_MaximumRepositoryNamesExceededException :: AsError a => Getting (First ServiceError) a ServiceError

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

InvalidRepositoryDescriptionException

_InvalidRepositoryDescriptionException :: AsError a => Getting (First ServiceError) a ServiceError

The specified repository description is not valid.

RepositoryNameExistsException

_RepositoryNameExistsException :: AsError a => Getting (First ServiceError) a ServiceError

The specified repository name already exists.

InvalidBranchNameException

_InvalidBranchNameException :: AsError a => Getting (First ServiceError) a ServiceError

The specified branch name is not valid.

BranchNameRequiredException

_BranchNameRequiredException :: AsError a => Getting (First ServiceError) a ServiceError

A branch name is required but was not specified.

EncryptionKeyUnavailableException

_EncryptionKeyUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError

The encryption key is not available.

RepositoryNamesRequiredException

_RepositoryNamesRequiredException :: AsError a => Getting (First ServiceError) a ServiceError

A repository names object is required but was not specified.

InvalidOrderException

_InvalidOrderException :: AsError a => Getting (First ServiceError) a ServiceError

The specified sort order is not valid.

BranchDoesNotExistException

_BranchDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError

The specified branch does not exist.

RepositoryDoesNotExistException

_RepositoryDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError

The specified repository does not exist.

EncryptionIntegrityChecksFailedException

_EncryptionIntegrityChecksFailedException :: AsError a => Getting (First ServiceError) a ServiceError

An encryption integrity check failed.

EncryptionKeyAccessDeniedException

_EncryptionKeyAccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError

An encryption key could not be accessed.

BranchNameExistsException

_BranchNameExistsException :: AsError a => Getting (First ServiceError) a ServiceError

The specified branch name already exists.

InvalidSortByException

_InvalidSortByException :: AsError a => Getting (First ServiceError) a ServiceError

The specified sort by value is not valid.

EncryptionKeyDisabledException

_EncryptionKeyDisabledException :: AsError a => Getting (First ServiceError) a ServiceError

The encryption key is disabled.

CommitIdRequiredException

_CommitIdRequiredException :: AsError a => Getting (First ServiceError) a ServiceError

A commit ID was not specified.

InvalidCommitIdException

_InvalidCommitIdException :: AsError a => Getting (First ServiceError) a ServiceError

The specified commit ID is not valid.

CommitDoesNotExistException

_CommitDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError

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

RepositoryNameRequiredException

_RepositoryNameRequiredException :: AsError a => Getting (First ServiceError) a ServiceError

A repository name is required but was not specified.

RepositoryLimitExceededException

_RepositoryLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError

A repository resource limit was exceeded.

InvalidRepositoryNameException

_InvalidRepositoryNameException :: AsError a => Getting (First ServiceError) a ServiceError

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.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

UpdateRepositoryName

module Network.AWS.CodeCommit.UpdateRepositoryName

GetBranch

module Network.AWS.CodeCommit.GetBranch

UpdateRepositoryDescription

module Network.AWS.CodeCommit.UpdateRepositoryDescription

CreateBranch

module Network.AWS.CodeCommit.CreateBranch

ListBranches

module Network.AWS.CodeCommit.ListBranches

ListRepositories

module Network.AWS.CodeCommit.ListRepositories

CreateRepository

module Network.AWS.CodeCommit.CreateRepository

UpdateDefaultBranch

module Network.AWS.CodeCommit.UpdateDefaultBranch

GetRepository

module Network.AWS.CodeCommit.GetRepository

DeleteRepository

module Network.AWS.CodeCommit.DeleteRepository

BatchGetRepositories

module Network.AWS.CodeCommit.BatchGetRepositories

Types

OrderEnum

data OrderEnum

Constructors

Ascending

Descending

Instances

Enum OrderEnum

Eq OrderEnum

Data OrderEnum

Ord OrderEnum

Read OrderEnum

Show OrderEnum

Generic OrderEnum

ToJSON OrderEnum

Hashable OrderEnum

ToHeader OrderEnum

ToQuery OrderEnum

ToByteString OrderEnum

FromText OrderEnum

ToText OrderEnum

type Rep OrderEnum

SortByEnum

data SortByEnum

Constructors

LastModifiedDate

RepositoryName

Instances

Enum SortByEnum

Eq SortByEnum

Data SortByEnum

Ord SortByEnum

Read SortByEnum

Show SortByEnum

Generic SortByEnum

ToJSON SortByEnum

Hashable SortByEnum

ToHeader SortByEnum

ToQuery SortByEnum

ToByteString SortByEnum

FromText SortByEnum

ToText SortByEnum

type Rep SortByEnum

BranchInfo

data BranchInfo

Returns information about a branch.

See: branchInfo smart constructor.

Instances

Eq BranchInfo

Data BranchInfo

Read BranchInfo

Show BranchInfo

Generic BranchInfo

FromJSON BranchInfo

type Rep BranchInfo

branchInfo :: BranchInfo

Creates a value of BranchInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• biCommitId
• biBranchName

biCommitId :: Lens' BranchInfo (Maybe Text)

The ID of the last commit made to the branch.

biBranchName :: Lens' BranchInfo (Maybe Text)

The name of the branch.

RepositoryMetadata

data RepositoryMetadata

Information about a repository.

See: repositoryMetadata smart constructor.

Instances

Eq RepositoryMetadata

Data RepositoryMetadata

Read RepositoryMetadata

Show RepositoryMetadata

Generic RepositoryMetadata

FromJSON RepositoryMetadata

type Rep RepositoryMetadata

repositoryMetadata :: RepositoryMetadata

Creates a value of RepositoryMetadata with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rmRepositoryDescription
• rmLastModifiedDate
• rmARN
• rmCloneURLHTTP
• rmAccountId
• rmDefaultBranch
• rmRepositoryId
• rmRepositoryName
• rmCreationDate
• rmCloneURLSSH

rmRepositoryDescription :: Lens' RepositoryMetadata (Maybe Text)

A comment or description about the repository.

rmLastModifiedDate :: Lens' RepositoryMetadata (Maybe UTCTime)

The date and time the repository was last modified, in timestamp format.

rmARN :: Lens' RepositoryMetadata (Maybe Text)

The Amazon Resource Name (ARN) of the repository.

rmCloneURLHTTP :: Lens' RepositoryMetadata (Maybe Text)

The URL to use for cloning the repository over HTTPS.

rmAccountId :: Lens' RepositoryMetadata (Maybe Text)

The ID of the AWS account associated with the repository.

rmDefaultBranch :: Lens' RepositoryMetadata (Maybe Text)

The repository's default branch name.

rmRepositoryId :: Lens' RepositoryMetadata (Maybe Text)

The ID of the repository.

rmRepositoryName :: Lens' RepositoryMetadata (Maybe Text)

The repository's name.

rmCreationDate :: Lens' RepositoryMetadata (Maybe UTCTime)

The date and time the repository was created, in timestamp format.

rmCloneURLSSH :: Lens' RepositoryMetadata (Maybe Text)

The URL to use for cloning the repository over SSH.

RepositoryNameIdPair

data RepositoryNameIdPair

Information about a repository name and ID.

See: repositoryNameIdPair smart constructor.

Instances

Eq RepositoryNameIdPair

Data RepositoryNameIdPair

Read RepositoryNameIdPair

Show RepositoryNameIdPair

Generic RepositoryNameIdPair

FromJSON RepositoryNameIdPair

type Rep RepositoryNameIdPair

repositoryNameIdPair :: RepositoryNameIdPair

Creates a value of RepositoryNameIdPair with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rnipRepositoryId
• rnipRepositoryName

rnipRepositoryId :: Lens' RepositoryNameIdPair (Maybe Text)

The ID associated with the repository name.

rnipRepositoryName :: Lens' RepositoryNameIdPair (Maybe Text)

Undocumented member.