Documentation
¶
Overview ¶
Package codecommit provides a client for AWS CodeCommit.
Index ¶
- Constants
- type BatchGetRepositoriesInput
- type BatchGetRepositoriesOutput
- type BranchInfo
- type CodeCommit
- func (c *CodeCommit) BatchGetRepositories(input *BatchGetRepositoriesInput) (*BatchGetRepositoriesOutput, error)
- func (c *CodeCommit) BatchGetRepositoriesRequest(input *BatchGetRepositoriesInput) (req *request.Request, output *BatchGetRepositoriesOutput)
- func (c *CodeCommit) CreateBranch(input *CreateBranchInput) (*CreateBranchOutput, error)
- func (c *CodeCommit) CreateBranchRequest(input *CreateBranchInput) (req *request.Request, output *CreateBranchOutput)
- func (c *CodeCommit) CreateRepository(input *CreateRepositoryInput) (*CreateRepositoryOutput, error)
- func (c *CodeCommit) CreateRepositoryRequest(input *CreateRepositoryInput) (req *request.Request, output *CreateRepositoryOutput)
- func (c *CodeCommit) DeleteRepository(input *DeleteRepositoryInput) (*DeleteRepositoryOutput, error)
- func (c *CodeCommit) DeleteRepositoryRequest(input *DeleteRepositoryInput) (req *request.Request, output *DeleteRepositoryOutput)
- func (c *CodeCommit) GetBranch(input *GetBranchInput) (*GetBranchOutput, error)
- func (c *CodeCommit) GetBranchRequest(input *GetBranchInput) (req *request.Request, output *GetBranchOutput)
- func (c *CodeCommit) GetRepository(input *GetRepositoryInput) (*GetRepositoryOutput, error)
- func (c *CodeCommit) GetRepositoryRequest(input *GetRepositoryInput) (req *request.Request, output *GetRepositoryOutput)
- func (c *CodeCommit) ListBranches(input *ListBranchesInput) (*ListBranchesOutput, error)
- func (c *CodeCommit) ListBranchesRequest(input *ListBranchesInput) (req *request.Request, output *ListBranchesOutput)
- func (c *CodeCommit) ListRepositories(input *ListRepositoriesInput) (*ListRepositoriesOutput, error)
- func (c *CodeCommit) ListRepositoriesRequest(input *ListRepositoriesInput) (req *request.Request, output *ListRepositoriesOutput)
- func (c *CodeCommit) UpdateDefaultBranch(input *UpdateDefaultBranchInput) (*UpdateDefaultBranchOutput, error)
- func (c *CodeCommit) UpdateDefaultBranchRequest(input *UpdateDefaultBranchInput) (req *request.Request, output *UpdateDefaultBranchOutput)
- func (c *CodeCommit) UpdateRepositoryDescription(input *UpdateRepositoryDescriptionInput) (*UpdateRepositoryDescriptionOutput, error)
- func (c *CodeCommit) UpdateRepositoryDescriptionRequest(input *UpdateRepositoryDescriptionInput) (req *request.Request, output *UpdateRepositoryDescriptionOutput)
- func (c *CodeCommit) UpdateRepositoryName(input *UpdateRepositoryNameInput) (*UpdateRepositoryNameOutput, error)
- func (c *CodeCommit) UpdateRepositoryNameRequest(input *UpdateRepositoryNameInput) (req *request.Request, output *UpdateRepositoryNameOutput)
- type CreateBranchInput
- type CreateBranchOutput
- type CreateRepositoryInput
- type CreateRepositoryOutput
- type DeleteRepositoryInput
- type DeleteRepositoryOutput
- type GetBranchInput
- type GetBranchOutput
- type GetRepositoryInput
- type GetRepositoryOutput
- type ListBranchesInput
- type ListBranchesOutput
- type ListRepositoriesInput
- type ListRepositoriesOutput
- type RepositoryMetadata
- type RepositoryNameIdPair
- type UpdateDefaultBranchInput
- type UpdateDefaultBranchOutput
- type UpdateRepositoryDescriptionInput
- type UpdateRepositoryDescriptionOutput
- type UpdateRepositoryNameInput
- type UpdateRepositoryNameOutput
Examples ¶
- CodeCommit.BatchGetRepositories
- CodeCommit.CreateBranch
- CodeCommit.CreateRepository
- CodeCommit.DeleteRepository
- CodeCommit.GetBranch
- CodeCommit.GetRepository
- CodeCommit.ListBranches
- CodeCommit.ListRepositories
- CodeCommit.UpdateDefaultBranch
- CodeCommit.UpdateRepositoryDescription
- CodeCommit.UpdateRepositoryName
Constants ¶
const (
// @enum OrderEnum
OrderEnumAscending = "ascending"
// @enum OrderEnum
OrderEnumDescending = "descending"
)
const (
// @enum SortByEnum
SortByEnumRepositoryName = "repositoryName"
// @enum SortByEnum
SortByEnumLastModifiedDate = "lastModifiedDate"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BatchGetRepositoriesInput ¶
type BatchGetRepositoriesInput struct {
// The names of the repositories to get information about.
RepositoryNames []*string `locationName:"repositoryNames" type:"list" required:"true"`
// contains filtered or unexported fields
}
Represents the input of a batch get repositories operation.
type BatchGetRepositoriesOutput ¶
type BatchGetRepositoriesOutput struct {
// A list of repositories returned by the batch get repositories operation.
Repositories []*RepositoryMetadata `locationName:"repositories" type:"list"`
// Returns a list of repository names for which information could not be found.
RepositoriesNotFound []*string `locationName:"repositoriesNotFound" type:"list"`
// contains filtered or unexported fields
}
Represents the output of a batch get repositories operation.
type BranchInfo ¶
type BranchInfo struct {
// The name of the branch.
BranchName *string `locationName:"branchName" min:"1" type:"string"`
// The ID of the last commit made to the branch.
CommitId *string `locationName:"commitId" type:"string"`
// contains filtered or unexported fields
}
Returns information about a branch.
type CodeCommit ¶
type CodeCommit struct {
*service.Service
}
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.
func (*CodeCommit) BatchGetRepositories ¶
func (c *CodeCommit) BatchGetRepositories(input *BatchGetRepositoriesInput) (*BatchGetRepositoriesOutput, error)
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.
func (*CodeCommit) BatchGetRepositoriesRequest ¶
func (c *CodeCommit) BatchGetRepositoriesRequest(input *BatchGetRepositoriesInput) (req *request.Request, output *BatchGetRepositoriesOutput)
BatchGetRepositoriesRequest generates a request for the BatchGetRepositories operation.
func (*CodeCommit) CreateBranch ¶
func (c *CodeCommit) CreateBranch(input *CreateBranchInput) (*CreateBranchOutput, error)
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.
func (*CodeCommit) CreateBranchRequest ¶
func (c *CodeCommit) CreateBranchRequest(input *CreateBranchInput) (req *request.Request, output *CreateBranchOutput)
CreateBranchRequest generates a request for the CreateBranch operation.
func (*CodeCommit) CreateRepository ¶
func (c *CodeCommit) CreateRepository(input *CreateRepositoryInput) (*CreateRepositoryOutput, error)
Creates a new, empty repository.
func (*CodeCommit) CreateRepositoryRequest ¶
func (c *CodeCommit) CreateRepositoryRequest(input *CreateRepositoryInput) (req *request.Request, output *CreateRepositoryOutput)
CreateRepositoryRequest generates a request for the CreateRepository operation.
func (*CodeCommit) DeleteRepository ¶
func (c *CodeCommit) DeleteRepository(input *DeleteRepositoryInput) (*DeleteRepositoryOutput, error)
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.
func (*CodeCommit) DeleteRepositoryRequest ¶
func (c *CodeCommit) DeleteRepositoryRequest(input *DeleteRepositoryInput) (req *request.Request, output *DeleteRepositoryOutput)
DeleteRepositoryRequest generates a request for the DeleteRepository operation.
func (*CodeCommit) GetBranch ¶
func (c *CodeCommit) GetBranch(input *GetBranchInput) (*GetBranchOutput, error)
Retrieves information about a repository branch, including its name and the last commit ID.
func (*CodeCommit) GetBranchRequest ¶
func (c *CodeCommit) GetBranchRequest(input *GetBranchInput) (req *request.Request, output *GetBranchOutput)
GetBranchRequest generates a request for the GetBranch operation.
func (*CodeCommit) GetRepository ¶
func (c *CodeCommit) GetRepository(input *GetRepositoryInput) (*GetRepositoryOutput, error)
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.
func (*CodeCommit) GetRepositoryRequest ¶
func (c *CodeCommit) GetRepositoryRequest(input *GetRepositoryInput) (req *request.Request, output *GetRepositoryOutput)
GetRepositoryRequest generates a request for the GetRepository operation.
func (*CodeCommit) ListBranches ¶
func (c *CodeCommit) ListBranches(input *ListBranchesInput) (*ListBranchesOutput, error)
Gets information about one or more branches in a repository.
func (*CodeCommit) ListBranchesRequest ¶
func (c *CodeCommit) ListBranchesRequest(input *ListBranchesInput) (req *request.Request, output *ListBranchesOutput)
ListBranchesRequest generates a request for the ListBranches operation.
func (*CodeCommit) ListRepositories ¶
func (c *CodeCommit) ListRepositories(input *ListRepositoriesInput) (*ListRepositoriesOutput, error)
Gets information about one or more repositories.
func (*CodeCommit) ListRepositoriesRequest ¶
func (c *CodeCommit) ListRepositoriesRequest(input *ListRepositoriesInput) (req *request.Request, output *ListRepositoriesOutput)
ListRepositoriesRequest generates a request for the ListRepositories operation.
func (*CodeCommit) UpdateDefaultBranch ¶
func (c *CodeCommit) UpdateDefaultBranch(input *UpdateDefaultBranchInput) (*UpdateDefaultBranchOutput, error)
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.
func (*CodeCommit) UpdateDefaultBranchRequest ¶
func (c *CodeCommit) UpdateDefaultBranchRequest(input *UpdateDefaultBranchInput) (req *request.Request, output *UpdateDefaultBranchOutput)
UpdateDefaultBranchRequest generates a request for the UpdateDefaultBranch operation.
func (*CodeCommit) UpdateRepositoryDescription ¶
func (c *CodeCommit) UpdateRepositoryDescription(input *UpdateRepositoryDescriptionInput) (*UpdateRepositoryDescriptionOutput, error)
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.
func (*CodeCommit) UpdateRepositoryDescriptionRequest ¶
func (c *CodeCommit) UpdateRepositoryDescriptionRequest(input *UpdateRepositoryDescriptionInput) (req *request.Request, output *UpdateRepositoryDescriptionOutput)
UpdateRepositoryDescriptionRequest generates a request for the UpdateRepositoryDescription operation.
func (*CodeCommit) UpdateRepositoryName ¶
func (c *CodeCommit) UpdateRepositoryName(input *UpdateRepositoryNameInput) (*UpdateRepositoryNameOutput, error)
Renames a repository.
func (*CodeCommit) UpdateRepositoryNameRequest ¶
func (c *CodeCommit) UpdateRepositoryNameRequest(input *UpdateRepositoryNameInput) (req *request.Request, output *UpdateRepositoryNameOutput)
UpdateRepositoryNameRequest generates a request for the UpdateRepositoryName operation.
type CreateBranchInput ¶
type CreateBranchInput struct {
// The name of the new branch to create.
BranchName *string `locationName:"branchName" min:"1" type:"string" required:"true"`
// The ID of the commit to point the new branch to.
//
// If this commit ID is not specified, the new branch will point to the commit
// that is pointed to by the repository's default branch.
CommitId *string `locationName:"commitId" type:"string" required:"true"`
// The name of the repository in which you want to create the new branch.
RepositoryName *string `locationName:"repositoryName" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
Represents the input of a create branch operation.
type CreateBranchOutput ¶
type CreateBranchOutput struct {
// contains filtered or unexported fields
}
type CreateRepositoryInput ¶
type CreateRepositoryInput struct {
// A comment or description about the new repository.
RepositoryDescription *string `locationName:"repositoryDescription" type:"string"`
// The name of the new repository to be created.
//
// The repository name must be unique across the calling AWS account. In addition,
// repository names are restricted to alphanumeric characters. The suffix ".git"
// is prohibited.
RepositoryName *string `locationName:"repositoryName" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
Represents the input of a create repository operation.
type CreateRepositoryOutput ¶
type CreateRepositoryOutput struct {
// Information about the newly created repository.
RepositoryMetadata *RepositoryMetadata `locationName:"repositoryMetadata" type:"structure"`
// contains filtered or unexported fields
}
Represents the output of a create repository operation.
type DeleteRepositoryInput ¶
type DeleteRepositoryInput struct {
// The name of the repository to delete.
RepositoryName *string `locationName:"repositoryName" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
Represents the input of a delete repository operation.
type DeleteRepositoryOutput ¶
type DeleteRepositoryOutput struct {
// The ID of the repository that was deleted.
RepositoryId *string `locationName:"repositoryId" type:"string"`
// contains filtered or unexported fields
}
Represents the output of a delete repository operation.
type GetBranchInput ¶
type GetBranchInput struct {
// The name of the branch for which you want to retrieve information.
BranchName *string `locationName:"branchName" min:"1" type:"string"`
// Repository name is restricted to alphanumeric characters (a-z, A-Z, 0-9),
// ".", "_", and "-". Additionally, the suffix ".git" is prohibited in a repository
// name.
RepositoryName *string `locationName:"repositoryName" min:"1" type:"string"`
// contains filtered or unexported fields
}
Represents the input of a get branch operation.
type GetBranchOutput ¶
type GetBranchOutput struct {
// The name of the branch.
Branch *BranchInfo `locationName:"branch" type:"structure"`
// contains filtered or unexported fields
}
Represents the output of a get branch operation.
type GetRepositoryInput ¶
type GetRepositoryInput struct {
// The name of the repository to get information about.
RepositoryName *string `locationName:"repositoryName" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
Represents the input of a get repository operation.
type GetRepositoryOutput ¶
type GetRepositoryOutput struct {
// Information about the repository.
RepositoryMetadata *RepositoryMetadata `locationName:"repositoryMetadata" type:"structure"`
// contains filtered or unexported fields
}
Represents the output of a get repository operation.
type ListBranchesInput ¶
type ListBranchesInput struct {
// An enumeration token that allows the operation to batch the results.
NextToken *string `locationName:"nextToken" type:"string"`
// The name of the repository that contains the branches.
RepositoryName *string `locationName:"repositoryName" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
Represents the input of a list branches operation.
type ListBranchesOutput ¶
type ListBranchesOutput struct {
// The list of branch names.
Branches []*string `locationName:"branches" type:"list"`
// An enumeration token that returns the batch of the results.
NextToken *string `locationName:"nextToken" type:"string"`
// contains filtered or unexported fields
}
Represents the output of a list branches operation.
type ListRepositoriesInput ¶
type ListRepositoriesInput struct {
// An enumeration token that allows the operation to batch the results of the
// operation. Batch sizes are 1,000 for list repository operations. When the
// client sends the token back to AWS CodeCommit, another page of 1,000 records
// is retrieved.
NextToken *string `locationName:"nextToken" type:"string"`
// The order in which to sort the results of a list repositories operation.
Order *string `locationName:"order" type:"string" enum:"OrderEnum"`
// The criteria used to sort the results of a list repositories operation.
SortBy *string `locationName:"sortBy" type:"string" enum:"SortByEnum"`
// contains filtered or unexported fields
}
Represents the input of a list repositories operation.
type ListRepositoriesOutput ¶
type ListRepositoriesOutput struct {
// An enumeration token that allows the operation to batch the results of the
// operation. Batch sizes are 1,000 for list repository operations. When the
// client sends the token back to AWS CodeCommit, another page of 1,000 records
// is retrieved.
NextToken *string `locationName:"nextToken" type:"string"`
// Lists the repositories called by the list repositories operation.
Repositories []*RepositoryNameIdPair `locationName:"repositories" type:"list"`
// contains filtered or unexported fields
}
Represents the output of a list repositories operation.
type RepositoryMetadata ¶
type RepositoryMetadata struct {
// The ID of the AWS account associated with the repository.
AccountId *string `locationName:"accountId" type:"string"`
// The Amazon Resource Name (ARN) of the repository.
Arn *string `type:"string"`
// The URL to use for cloning the repository over HTTPS.
CloneUrlHttp *string `locationName:"cloneUrlHttp" type:"string"`
// The URL to use for cloning the repository over SSH.
CloneUrlSsh *string `locationName:"cloneUrlSsh" type:"string"`
// The date and time the repository was created, in timestamp format.
CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix"`
// The repository's default branch name.
DefaultBranch *string `locationName:"defaultBranch" min:"1" type:"string"`
// The date and time the repository was last modified, in timestamp format.
LastModifiedDate *time.Time `locationName:"lastModifiedDate" type:"timestamp" timestampFormat:"unix"`
// A comment or description about the repository.
RepositoryDescription *string `locationName:"repositoryDescription" type:"string"`
// The ID of the repository.
RepositoryId *string `locationName:"repositoryId" type:"string"`
// The repository's name.
RepositoryName *string `locationName:"repositoryName" min:"1" type:"string"`
// contains filtered or unexported fields
}
Information about a repository.
type RepositoryNameIdPair ¶ added in v0.9.5
type RepositoryNameIdPair struct {
// The ID associated with the repository name.
RepositoryId *string `locationName:"repositoryId" type:"string"`
// Repository name is restricted to alphanumeric characters (a-z, A-Z, 0-9),
// ".", "_", and "-". Additionally, the suffix ".git" is prohibited in a repository
// name.
RepositoryName *string `locationName:"repositoryName" min:"1" type:"string"`
// contains filtered or unexported fields
}
Information about a repository name and ID.
type UpdateDefaultBranchInput ¶
type UpdateDefaultBranchInput struct {
// The name of the branch to set as the default.
DefaultBranchName *string `locationName:"defaultBranchName" min:"1" type:"string" required:"true"`
// The name of the repository to set or change the default branch for.
RepositoryName *string `locationName:"repositoryName" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
Represents the input of an update default branch operation.
type UpdateDefaultBranchOutput ¶
type UpdateDefaultBranchOutput struct {
// contains filtered or unexported fields
}
type UpdateRepositoryDescriptionInput ¶
type UpdateRepositoryDescriptionInput struct {
// The new comment or description for the specified repository.
RepositoryDescription *string `locationName:"repositoryDescription" type:"string"`
// The name of the repository to set or change the comment or description for.
RepositoryName *string `locationName:"repositoryName" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
Represents the input of an update repository description operation.
type UpdateRepositoryDescriptionOutput ¶
type UpdateRepositoryDescriptionOutput struct {
// contains filtered or unexported fields
}
type UpdateRepositoryNameInput ¶
type UpdateRepositoryNameInput struct {
// Repository name is restricted to alphanumeric characters (a-z, A-Z, 0-9),
// ".", "_", and "-". Additionally, the suffix ".git" is prohibited in a repository
// name.
NewName *string `locationName:"newName" min:"1" type:"string" required:"true"`
// Repository name is restricted to alphanumeric characters (a-z, A-Z, 0-9),
// ".", "_", and "-". Additionally, the suffix ".git" is prohibited in a repository
// name.
OldName *string `locationName:"oldName" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
Represents the input of an update repository description operation.
type UpdateRepositoryNameOutput ¶
type UpdateRepositoryNameOutput struct {
// contains filtered or unexported fields
}
Directories
¶
Path | Synopsis |
---|---|
Package codecommitiface provides an interface for the AWS CodeCommit.
|
Package codecommitiface provides an interface for the AWS CodeCommit. |