Copyright	(c) 2013-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.CodeCommit

Contents

Service Configuration
Errors
Waiters
Operations
Types

Description

AWS CodeCommit

This is the AWS CodeCommit API Reference. This reference provides descriptions of the operations and data types for AWS CodeCommit API.

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

Repositories, by calling the following:
BatchGetRepositories, which returns information about one or more repositories associated with your AWS account
CreateRepository, which creates an AWS CodeCommit repository
DeleteRepository, which deletes an AWS CodeCommit repository
GetRepository, which returns information about a specified repository
ListRepositories, which lists all AWS CodeCommit repositories associated with your AWS account
UpdateRepositoryDescription, which sets or updates the description of the repository
UpdateRepositoryName, which changes the name of the repository. If you change the name of a repository, no other users of that repository will be able to access it until you send them the new HTTPS or SSH URL to use.
Branches, by calling the following:
CreateBranch, which creates a new branch in a specified repository
GetBranch, which returns information about a specified branch
ListBranches, which lists all branches for a specified repository
UpdateDefaultBranch, which changes the default branch for a repository
Information about committed code in a repository, by calling the following:
GetCommit, which returns information about a commit, including commit messages and committer information.
Triggers, by calling the following:
GetRepositoryTriggers, which returns information about triggers configured for a repository
PutRepositoryTriggers, which replaces all triggers for a repository and can be used to create or delete triggers
TestRepositoryTriggers, which tests the functionality of a repository trigger by sending data to the trigger target

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

Synopsis

Service Configuration

codeCommit :: Service Source

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.

InvalidRepositoryTriggerRegionException

_InvalidRepositoryTriggerRegionException :: AsError a => Getting (First ServiceError) a ServiceError Source

The region for the trigger target does not match the region for the repository. Triggers must be created in the same region as the target for the trigger.

InvalidContinuationTokenException

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

The specified continuation token is not valid.

EncryptionKeyNotFoundException

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

No encryption key was found.

InvalidRepositoryTriggerBranchNameException

_InvalidRepositoryTriggerBranchNameException :: AsError a => Getting (First ServiceError) a ServiceError Source

One or more branch names specified for the trigger is not valid.

InvalidRepositoryTriggerCustomDataException

_InvalidRepositoryTriggerCustomDataException :: AsError a => Getting (First ServiceError) a ServiceError Source

The custom data provided for the trigger is not valid.

MaximumRepositoryNamesExceededException

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

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

InvalidRepositoryDescriptionException

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

The specified repository description is not valid.

RepositoryNameExistsException

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

The specified repository name already exists.

MaximumRepositoryTriggersExceededException

_MaximumRepositoryTriggersExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source

The number of triggers allowed for the repository was exceeded.

InvalidBranchNameException

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

The specified branch name is not valid.

BranchNameRequiredException

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

A branch name is required but was not specified.

RepositoryTriggersListRequiredException

_RepositoryTriggersListRequiredException :: AsError a => Getting (First ServiceError) a ServiceError Source

The list of triggers for the repository is required but was not specified.

EncryptionKeyUnavailableException

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

The encryption key is not available.

InvalidRepositoryTriggerDestinationARNException

_InvalidRepositoryTriggerDestinationARNException :: AsError a => Getting (First ServiceError) a ServiceError Source

The Amazon Resource Name (ARN) for the trigger is not valid for the specified destination. The most common reason for this error is that the ARN does not meet the requirements for the service type.

RepositoryNamesRequiredException

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

A repository names object is required but was not specified.

InvalidOrderException

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

The specified sort order is not valid.

BranchDoesNotExistException

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

The specified branch does not exist.

RepositoryTriggerNameRequiredException

_RepositoryTriggerNameRequiredException :: AsError a => Getting (First ServiceError) a ServiceError Source

A name for the trigger is required but was not specified.

RepositoryDoesNotExistException

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

The specified repository does not exist.

MaximumBranchesExceededException

_MaximumBranchesExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source

The number of branches for the trigger was exceeded.

EncryptionIntegrityChecksFailedException

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

An encryption integrity check failed.

RepositoryTriggerEventsListRequiredException

_RepositoryTriggerEventsListRequiredException :: AsError a => Getting (First ServiceError) a ServiceError Source

At least one event for the trigger is required but was not specified.

EncryptionKeyAccessDeniedException

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

An encryption key could not be accessed.

BranchNameExistsException

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

The specified branch name already exists.

InvalidSortByException

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

The specified sort by value is not valid.

EncryptionKeyDisabledException

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

The encryption key is disabled.

CommitIdRequiredException

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

A commit ID was not specified.

InvalidCommitIdException

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

The specified commit ID is not valid.

RepositoryTriggerDestinationARNRequiredException

_RepositoryTriggerDestinationARNRequiredException :: AsError a => Getting (First ServiceError) a ServiceError Source

A destination ARN for the target service for the trigger is required but was not specified.

CommitDoesNotExistException

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

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

RepositoryTriggerBranchNameListRequiredException

_RepositoryTriggerBranchNameListRequiredException :: AsError a => Getting (First ServiceError) a ServiceError Source

At least one branch name is required but was not specified in the trigger configuration.

CommitIdDoesNotExistException

_CommitIdDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified commit ID does not exist.

InvalidRepositoryTriggerNameException

_InvalidRepositoryTriggerNameException :: AsError a => Getting (First ServiceError) a ServiceError Source

The name of the trigger is not valid.

RepositoryNameRequiredException

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

A repository name is required but was not specified.

RepositoryLimitExceededException

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

A repository resource limit was exceeded.

InvalidRepositoryTriggerEventsException

_InvalidRepositoryTriggerEventsException :: AsError a => Getting (First ServiceError) a ServiceError Source

One or more events specified for the trigger is not valid. Check to make sure that all events specified match the requirements for allowed events.

InvalidRepositoryNameException

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

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

GetCommit

module Network.AWS.CodeCommit.GetCommit

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

GetRepositoryTriggers

module Network.AWS.CodeCommit.GetRepositoryTriggers

TestRepositoryTriggers

module Network.AWS.CodeCommit.TestRepositoryTriggers

PutRepositoryTriggers

module Network.AWS.CodeCommit.PutRepositoryTriggers

DeleteRepository

module Network.AWS.CodeCommit.DeleteRepository

BatchGetRepositories

module Network.AWS.CodeCommit.BatchGetRepositories

Types

OrderEnum

RepositoryTriggerEventEnum

SortByEnum

BranchInfo

data BranchInfo Source

Returns information about a branch.

See: branchInfo smart constructor.

branchInfo :: BranchInfo Source

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) Source

The ID of the last commit made to the branch.

biBranchName :: Lens' BranchInfo (Maybe Text) Source

The name of the branch.

Commit

data Commit Source

Returns information about a specific commit.

See: commit smart constructor.

Instances

Eq Commit Source
Data Commit Source
Read Commit Source
Show Commit Source
Generic Commit Source
FromJSON Commit Source
Hashable Commit Source
type Rep Commit Source

commit :: Commit Source

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

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

cCommitter :: Lens' Commit (Maybe UserInfo) Source

Information about the person who committed the specified commit, also known as the committer. For more information about the difference between an author and a committer in Git, see Viewing the Commit History in Pro Git by Scott Chacon and Ben Straub.

cTreeId :: Lens' Commit (Maybe Text) Source

Tree information for the specified commit.

cAdditionalData :: Lens' Commit (Maybe Text) Source

Any additional data associated with the specified commit.

cParents :: Lens' Commit [Text] Source

The parent list for the specified commit.

cAuthor :: Lens' Commit (Maybe UserInfo) Source

Information about the author of the specified commit.

cMessage :: Lens' Commit (Maybe Text) Source

The message associated with the specified commit.

RepositoryMetadata

data RepositoryMetadata Source

Information about a repository.

See: repositoryMetadata smart constructor.

repositoryMetadata :: RepositoryMetadata Source

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 :: Lens' RepositoryMetadata (Maybe Text) Source

A comment or description about the repository.

rmLastModifiedDate :: Lens' RepositoryMetadata (Maybe UTCTime) Source

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

rmARN :: Lens' RepositoryMetadata (Maybe Text) Source

The Amazon Resource Name (ARN) of the repository.

rmCloneURLHTTP :: Lens' RepositoryMetadata (Maybe Text) Source

The URL to use for cloning the repository over HTTPS.

rmAccountId :: Lens' RepositoryMetadata (Maybe Text) Source

The ID of the AWS account associated with the repository.

rmDefaultBranch :: Lens' RepositoryMetadata (Maybe Text) Source

The repository's default branch name.

rmRepositoryId :: Lens' RepositoryMetadata (Maybe Text) Source

The ID of the repository.

rmRepositoryName :: Lens' RepositoryMetadata (Maybe Text) Source

The repository's name.

rmCreationDate :: Lens' RepositoryMetadata (Maybe UTCTime) Source

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

rmCloneURLSSH :: Lens' RepositoryMetadata (Maybe Text) Source

The URL to use for cloning the repository over SSH.

RepositoryNameIdPair

data RepositoryNameIdPair Source

Information about a repository name and ID.

See: repositoryNameIdPair smart constructor.

repositoryNameIdPair :: RepositoryNameIdPair Source

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 :: Lens' RepositoryNameIdPair (Maybe Text) Source

The ID associated with the repository.

rnipRepositoryName :: Lens' RepositoryNameIdPair (Maybe Text) Source

The name associated with the repository.

RepositoryTrigger

data RepositoryTrigger Source

Information about a trigger for a repository.

See: repositoryTrigger smart constructor.

repositoryTrigger :: RepositoryTrigger Source

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

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

rtBranches :: Lens' RepositoryTrigger [Text] Source

The branches that will be included in the trigger configuration. If no branches are specified, the trigger will apply to all branches.

rtCustomData :: Lens' RepositoryTrigger (Maybe Text) Source

Any custom data associated with the trigger that will be included in the information sent to the target of the trigger.

rtDestinationARN :: Lens' RepositoryTrigger (Maybe Text) Source

The ARN of the resource that is the target for a trigger. For example, the ARN of a topic in Amazon Simple Notification Service (SNS).

rtName :: Lens' RepositoryTrigger (Maybe Text) Source

The name of the trigger.

rtEvents :: Lens' RepositoryTrigger [RepositoryTriggerEventEnum] Source

The repository events that will cause the trigger to run actions in another service, such as sending a notification through Amazon Simple Notification Service (SNS). If no events are specified, the trigger will run for all repository events.

RepositoryTriggerExecutionFailure

repositoryTriggerExecutionFailure :: RepositoryTriggerExecutionFailure Source

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

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

rtefFailureMessage :: Lens' RepositoryTriggerExecutionFailure (Maybe Text) Source

Additional message information about the trigger that did not run.

rtefTrigger :: Lens' RepositoryTriggerExecutionFailure (Maybe Text) Source

The name of the trigger that did not run.

UserInfo

data UserInfo Source

Information about the user who made a specified commit.

See: userInfo smart constructor.

Instances

Eq UserInfo Source
Data UserInfo Source
Read UserInfo Source
Show UserInfo Source
Generic UserInfo Source
FromJSON UserInfo Source
Hashable UserInfo Source
type Rep UserInfo Source

userInfo :: UserInfo Source

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

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

uiEmail :: Lens' UserInfo (Maybe Text) Source

The email address associated with the user who made the commit, if any.

uiDate :: Lens' UserInfo (Maybe Text) Source

The date when the specified commit was pushed to the repository.

uiName :: Lens' UserInfo (Maybe Text) Source

The name of the user who made the specified commit.

Bounded OrderEnum Source
Enum OrderEnum Source
Eq OrderEnum Source
Data OrderEnum Source
Ord OrderEnum Source
Read OrderEnum Source
Show OrderEnum Source
Generic OrderEnum Source
ToJSON OrderEnum Source
Hashable OrderEnum Source
ToHeader OrderEnum Source
ToQuery OrderEnum Source
ToByteString OrderEnum Source
FromText OrderEnum Source
ToText OrderEnum Source
type Rep OrderEnum Source

All
CreateReference
DeleteReference
UpdateReference

Bounded RepositoryTriggerEventEnum Source
Enum RepositoryTriggerEventEnum Source
Eq RepositoryTriggerEventEnum Source
Data RepositoryTriggerEventEnum Source
Ord RepositoryTriggerEventEnum Source
Read RepositoryTriggerEventEnum Source
Show RepositoryTriggerEventEnum Source
Generic RepositoryTriggerEventEnum Source
ToJSON RepositoryTriggerEventEnum Source
FromJSON RepositoryTriggerEventEnum Source
Hashable RepositoryTriggerEventEnum Source
ToHeader RepositoryTriggerEventEnum Source
ToQuery RepositoryTriggerEventEnum Source
ToByteString RepositoryTriggerEventEnum Source
FromText RepositoryTriggerEventEnum Source
ToText RepositoryTriggerEventEnum Source
type Rep RepositoryTriggerEventEnum Source

Bounded SortByEnum Source
Enum SortByEnum Source
Eq SortByEnum Source
Data SortByEnum Source
Ord SortByEnum Source
Read SortByEnum Source
Show SortByEnum Source
Generic SortByEnum Source
ToJSON SortByEnum Source
Hashable SortByEnum Source
ToHeader SortByEnum Source
ToQuery SortByEnum Source
ToByteString SortByEnum Source
FromText SortByEnum Source
ToText SortByEnum Source
type Rep SortByEnum Source

Eq BranchInfo Source
Data BranchInfo Source
Read BranchInfo Source
Show BranchInfo Source
Generic BranchInfo Source
FromJSON BranchInfo Source
Hashable BranchInfo Source
type Rep BranchInfo Source

Eq RepositoryMetadata Source
Data RepositoryMetadata Source
Read RepositoryMetadata Source
Show RepositoryMetadata Source
Generic RepositoryMetadata Source
FromJSON RepositoryMetadata Source
Hashable RepositoryMetadata Source
type Rep RepositoryMetadata Source

Eq RepositoryNameIdPair Source
Data RepositoryNameIdPair Source
Read RepositoryNameIdPair Source
Show RepositoryNameIdPair Source
Generic RepositoryNameIdPair Source
FromJSON RepositoryNameIdPair Source
Hashable RepositoryNameIdPair Source
type Rep RepositoryNameIdPair Source

Eq RepositoryTrigger Source
Data RepositoryTrigger Source
Read RepositoryTrigger Source
Show RepositoryTrigger Source
Generic RepositoryTrigger Source
ToJSON RepositoryTrigger Source
FromJSON RepositoryTrigger Source
Hashable RepositoryTrigger Source
type Rep RepositoryTrigger Source

Eq RepositoryTriggerExecutionFailure Source
Data RepositoryTriggerExecutionFailure Source
Read RepositoryTriggerExecutionFailure Source
Show RepositoryTriggerExecutionFailure Source
Generic RepositoryTriggerExecutionFailure Source
FromJSON RepositoryTriggerExecutionFailure Source
Hashable RepositoryTriggerExecutionFailure Source
type Rep RepositoryTriggerExecutionFailure Source