codecommit

package
v1.0.7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 21, 2015 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package codecommit provides a client for AWS CodeCommit.

Index

Examples

Constants

View Source
const (
	// @enum OrderEnum
	OrderEnumAscending = "ascending"
	// @enum OrderEnum
	OrderEnumDescending = "descending"
)
View Source
const (
	// @enum SortByEnum
	SortByEnumRepositoryName = "repositoryName"
	// @enum SortByEnum
	SortByEnumLastModifiedDate = "lastModifiedDate"
)
View Source
const ServiceName = "codecommit"

A ServiceName is the name of the service the client will make API calls to.

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.

func (BatchGetRepositoriesInput) GoString

func (s BatchGetRepositoriesInput) GoString() string

GoString returns the string representation

func (BatchGetRepositoriesInput) String

func (s BatchGetRepositoriesInput) String() string

String returns the string representation

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.

func (BatchGetRepositoriesOutput) GoString

func (s BatchGetRepositoriesOutput) GoString() string

GoString returns the string representation

func (BatchGetRepositoriesOutput) String

String returns the string representation

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.

func (BranchInfo) GoString

func (s BranchInfo) GoString() string

GoString returns the string representation

func (BranchInfo) String

func (s BranchInfo) String() string

String returns the string representation

type CodeCommit

type CodeCommit struct {
	*client.Client
}

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. The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *CodeCommit

New creates a new instance of the CodeCommit client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a CodeCommit client from just a session.
svc := codecommit.New(mySession)

// Create a CodeCommit client with additional configuration
svc := codecommit.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

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.

Example
Output:

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.

Example
Output:

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.

Example
Output:

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.

Example
Output:

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.

Example
Output:

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.

Example
Output:

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.

Example
Output:

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.

Example
Output:

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.

Example
Output:

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.

Example
Output:

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.

Example
Output:

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.

func (CreateBranchInput) GoString

func (s CreateBranchInput) GoString() string

GoString returns the string representation

func (CreateBranchInput) String

func (s CreateBranchInput) String() string

String returns the string representation

type CreateBranchOutput

type CreateBranchOutput struct {
	// contains filtered or unexported fields
}

func (CreateBranchOutput) GoString

func (s CreateBranchOutput) GoString() string

GoString returns the string representation

func (CreateBranchOutput) String

func (s CreateBranchOutput) String() string

String returns the string representation

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.

func (CreateRepositoryInput) GoString

func (s CreateRepositoryInput) GoString() string

GoString returns the string representation

func (CreateRepositoryInput) String

func (s CreateRepositoryInput) String() string

String returns the string representation

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.

func (CreateRepositoryOutput) GoString

func (s CreateRepositoryOutput) GoString() string

GoString returns the string representation

func (CreateRepositoryOutput) String

func (s CreateRepositoryOutput) String() string

String returns the string representation

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.

func (DeleteRepositoryInput) GoString

func (s DeleteRepositoryInput) GoString() string

GoString returns the string representation

func (DeleteRepositoryInput) String

func (s DeleteRepositoryInput) String() string

String returns the string representation

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.

func (DeleteRepositoryOutput) GoString

func (s DeleteRepositoryOutput) GoString() string

GoString returns the string representation

func (DeleteRepositoryOutput) String

func (s DeleteRepositoryOutput) String() string

String returns the string representation

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.

func (GetBranchInput) GoString

func (s GetBranchInput) GoString() string

GoString returns the string representation

func (GetBranchInput) String

func (s GetBranchInput) String() string

String returns the string representation

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.

func (GetBranchOutput) GoString

func (s GetBranchOutput) GoString() string

GoString returns the string representation

func (GetBranchOutput) String

func (s GetBranchOutput) String() string

String returns the string representation

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.

func (GetRepositoryInput) GoString

func (s GetRepositoryInput) GoString() string

GoString returns the string representation

func (GetRepositoryInput) String

func (s GetRepositoryInput) String() string

String returns the string representation

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.

func (GetRepositoryOutput) GoString

func (s GetRepositoryOutput) GoString() string

GoString returns the string representation

func (GetRepositoryOutput) String

func (s GetRepositoryOutput) String() string

String returns the string representation

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.

func (ListBranchesInput) GoString

func (s ListBranchesInput) GoString() string

GoString returns the string representation

func (ListBranchesInput) String

func (s ListBranchesInput) String() string

String returns the string representation

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.

func (ListBranchesOutput) GoString

func (s ListBranchesOutput) GoString() string

GoString returns the string representation

func (ListBranchesOutput) String

func (s ListBranchesOutput) String() string

String returns the string representation

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.

func (ListRepositoriesInput) GoString

func (s ListRepositoriesInput) GoString() string

GoString returns the string representation

func (ListRepositoriesInput) String

func (s ListRepositoriesInput) String() string

String returns the string representation

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.

func (ListRepositoriesOutput) GoString

func (s ListRepositoriesOutput) GoString() string

GoString returns the string representation

func (ListRepositoriesOutput) String

func (s ListRepositoriesOutput) String() string

String returns the string representation

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.

func (RepositoryMetadata) GoString

func (s RepositoryMetadata) GoString() string

GoString returns the string representation

func (RepositoryMetadata) String

func (s RepositoryMetadata) String() string

String returns the string representation

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.

func (RepositoryNameIdPair) GoString added in v0.9.5

func (s RepositoryNameIdPair) GoString() string

GoString returns the string representation

func (RepositoryNameIdPair) String added in v0.9.5

func (s RepositoryNameIdPair) String() string

String returns the string representation

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.

func (UpdateDefaultBranchInput) GoString

func (s UpdateDefaultBranchInput) GoString() string

GoString returns the string representation

func (UpdateDefaultBranchInput) String

func (s UpdateDefaultBranchInput) String() string

String returns the string representation

type UpdateDefaultBranchOutput

type UpdateDefaultBranchOutput struct {
	// contains filtered or unexported fields
}

func (UpdateDefaultBranchOutput) GoString

func (s UpdateDefaultBranchOutput) GoString() string

GoString returns the string representation

func (UpdateDefaultBranchOutput) String

func (s UpdateDefaultBranchOutput) String() string

String returns the string representation

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.

func (UpdateRepositoryDescriptionInput) GoString

GoString returns the string representation

func (UpdateRepositoryDescriptionInput) String

String returns the string representation

type UpdateRepositoryDescriptionOutput

type UpdateRepositoryDescriptionOutput struct {
	// contains filtered or unexported fields
}

func (UpdateRepositoryDescriptionOutput) GoString

GoString returns the string representation

func (UpdateRepositoryDescriptionOutput) String

String returns the string representation

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.

func (UpdateRepositoryNameInput) GoString

func (s UpdateRepositoryNameInput) GoString() string

GoString returns the string representation

func (UpdateRepositoryNameInput) String

func (s UpdateRepositoryNameInput) String() string

String returns the string representation

type UpdateRepositoryNameOutput

type UpdateRepositoryNameOutput struct {
	// contains filtered or unexported fields
}

func (UpdateRepositoryNameOutput) GoString

func (s UpdateRepositoryNameOutput) GoString() string

GoString returns the string representation

func (UpdateRepositoryNameOutput) String

String returns the string representation

Directories

Path Synopsis
Package codecommitiface provides an interface for the AWS CodeCommit.
Package codecommitiface provides an interface for the AWS CodeCommit.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL