AWS SDK for PHP
  • Namespace
  • Class
  • Tree
  • Download

Namespaces

  • Aws
    • AutoScaling
      • Enum
      • Exception
    • CloudFormation
      • Enum
      • Exception
    • CloudFront
      • Enum
      • Exception
    • CloudFront_2012_05_05
    • CloudHsm
      • Exception
    • CloudSearch
      • Enum
      • Exception
    • CloudSearch_2011_02_01
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudWatch
      • Enum
      • Exception
    • CloudWatchLogs
      • Exception
    • CodeCommit
      • Exception
    • CodeDeploy
      • Exception
    • CodePipeline
      • Exception
    • CognitoIdentity
      • Exception
    • CognitoSync
      • Exception
    • Common
      • Client
      • Command
      • Credentials
      • Enum
      • Exception
        • Parser
      • Hash
      • InstanceMetadata
        • Waiter
      • Iterator
      • Model
        • MultipartUpload
      • Signature
      • Waiter
    • ConfigService
      • Exception
    • DataPipeline
      • Enum
      • Exception
    • DeviceFarm
      • Exception
    • DirectConnect
      • Enum
      • Exception
    • DirectoryService
      • Exception
    • DynamoDb
      • Enum
      • Exception
      • Model
        • BatchRequest
      • Session
        • LockingStrategy
    • DynamoDb_2011_12_05
    • DynamoDbStreams
      • Exception
    • Ec2
      • Enum
      • Exception
      • Iterator
    • Ecs
      • Exception
    • Efs
      • Exception
    • ElastiCache
      • Enum
      • Exception
    • ElasticBeanstalk
      • Enum
      • Exception
    • ElasticFileSystem
    • ElasticLoadBalancing
      • Exception
    • ElasticTranscoder
      • Exception
    • Emr
      • Enum
      • Exception
    • Glacier
      • Enum
      • Exception
      • Model
        • MultipartUpload
    • Iam
      • Enum
      • Exception
    • ImportExport
      • Enum
      • Exception
    • Kinesis
      • Enum
      • Exception
    • Kms
      • Exception
    • Lambda
      • Exception
    • MachineLearning
      • Exception
    • OpsWorks
      • Enum
      • Exception
    • Rds
      • Enum
      • Exception
    • Redshift
      • Enum
      • Exception
    • Route53
      • Enum
      • Exception
    • Route53Domains
      • Exception
    • S3
      • Command
      • Enum
      • Exception
        • Parser
      • Iterator
      • Model
        • MultipartUpload
      • Sync
    • Ses
      • Enum
      • Exception
    • SimpleDb
      • Exception
    • Sns
      • Exception
      • MessageValidator
        • Exception
    • Sqs
      • Enum
      • Exception
    • Ssm
      • Exception
    • StorageGateway
      • Enum
      • Exception
    • Sts
      • Exception
    • Support
      • Exception
    • Swf
      • Enum
      • Exception
    • WorkSpaces
      • Exception
  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
        • Header
      • QueryAggregator
    • Inflection
    • Iterator
    • Log
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Async
      • Backoff
      • Cache
      • Cookie
        • CookieJar
        • Exception
      • ErrorResponse
        • Exception
      • History
      • Log
      • Md5
      • Mock
      • Oauth
    • Service
      • Builder
      • Command
        • Factory
        • LocationVisitor
          • Request
          • Response
      • Description
      • Exception
      • Resource
    • Stream
  • PHP

Classes

  • CodeCommitClient
NOTE: For Version 3 of the AWS SDK for PHP, please see the V3 User Guide and V3 API Reference.

Class CodeCommitClient

Client to interact with AWS CodeCommit

Guzzle\Common\AbstractHasDispatcher implements Guzzle\Common\HasDispatcherInterface
Extended by Guzzle\Http\Client implements Guzzle\Http\ClientInterface
Extended by Guzzle\Service\Client implements Guzzle\Service\ClientInterface
Extended by Aws\Common\Client\AbstractClient implements Aws\Common\Client\AwsClientInterface
Extended by Aws\CodeCommit\CodeCommitClient
Namespace: Aws\CodeCommit
Link: User guide
Link: API docs
Located at Aws/CodeCommit/CodeCommitClient.php

Methods summary

  • public static factory ( array $config = array() )

    Executes the UpdateRepositoryName operation.

  • public batchGetRepositories ( array $args = array() )

    Executes the BatchGetRepositories operation.

  • public createBranch ( array $args = array() )

    Executes the CreateBranch operation.

  • public createRepository ( array $args = array() )

    Executes the CreateRepository operation.

  • public deleteRepository ( array $args = array() )

    Executes the DeleteRepository operation.

  • public getBranch ( array $args = array() )

    Executes the GetBranch operation.

  • public getRepository ( array $args = array() )

    Executes the GetRepository operation.

  • public listBranches ( array $args = array() )

    Executes the ListBranches operation.

  • public listRepositories ( array $args = array() )

    Executes the ListRepositories operation.

  • public updateDefaultBranch ( array $args = array() )

    Executes the UpdateDefaultBranch operation.

  • public updateRepositoryDescription ( array $args = array() )

    Executes the UpdateRepositoryDescription operation.

  • public updateRepositoryName ( array $args = array() )

    Executes the UpdateRepositoryName operation.

  • public getListBranchesIterator ( array $args = array() )

    The input array uses the parameters of the ListBranches operation

  • public getListRepositoriesIterator ( array $args = array() )

    The input array uses the parameters of the ListRepositories operation

Methods detail

# public static Guzzle\Service\Resource\Model
factory( array $config = array() )

Executes the UpdateRepositoryName operation.

Renames a repository.

Parameters

$config
array
$arg Associative array containing the following keys (required keys are bold):
  • oldName => (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.
  • newName => (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.

Returns

Guzzle\Service\Resource\Model
Returns a response Model object

    Overrides

    Guzzle\Service\Client::factory
    # public Guzzle\Service\Resource\Model
    batchGetRepositories( array $args = array() )

    Executes the BatchGetRepositories operation.

    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.

    Examples

    • Basic formatting example
      $result = $client->batchGetRepositories(array(
          // repositoryNames is required
          'repositoryNames' => array('string', ... ),
      ));
      

    Parameters

    $args
    array
    $arg Associative array containing the following keys (required keys are bold):
    • repositoryNames => (array<string>)

      The names of the repositories to get information about.

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

    Returns

    Guzzle\Service\Resource\Model
    Returns a response Model object
    • repositories => (array<associative-array>)

      A list of repositories returned by the batch get repositories operation.

      • (associative-array)

        Information about a repository.

        • accountId => (string)

          The ID of the AWS account associated with the repository.

        • repositoryId => (string)

          The ID of the repository.

        • repositoryName => (string)

          The repository's name.

        • repositoryDescription => (string)

          A comment or description about the repository.

        • defaultBranch => (string)

          The repository's default branch name.

        • lastModifiedDate => (string)

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

        • creationDate => (string)

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

        • cloneUrlHttp => (string)

          The URL to use for cloning the repository over HTTPS.

        • cloneUrlSsh => (string)

          The URL to use for cloning the repository over SSH.

        • Arn => (string)

          The Amazon Resource Name (ARN) of the repository.

    • repositoriesNotFound => (array<string>)

      Returns a list of repository names for which information could not be found.

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

    # public Guzzle\Service\Resource\Model
    createBranch( array $args = array() )

    Executes the CreateBranch operation.

    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.

    Examples

    • Basic formatting example
      $result = $client->createBranch(array(
          // repositoryName is required
          'repositoryName' => 'string',
          // branchName is required
          'branchName' => 'string',
          // commitId is required
          'commitId' => 'string',
      ));
      

    Parameters

    $args
    array
    $arg Associative array containing the following keys (required keys are bold):
    • repositoryName => (string)

      The name of the repository in which you want to create the new branch.

    • branchName => (string)

      The name of the new branch to create.

    • commitId => (string)

      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.

    Returns

    Guzzle\Service\Resource\Model
    Returns a response Model object

      # public Guzzle\Service\Resource\Model
      createRepository( array $args = array() )

      Executes the CreateRepository operation.

      Creates a new, empty repository.

      Examples

      • Basic formatting example
        $result = $client->createRepository(array(
            // repositoryName is required
            'repositoryName' => 'string',
            'repositoryDescription' => 'string',
        ));
        

      Parameters

      $args
      array
      $arg Associative array containing the following keys (required keys are bold):
      • repositoryName => (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.
      • repositoryDescription => (string)

        A comment or description about the new repository.

      Returns

      Guzzle\Service\Resource\Model
      Returns a response Model object
      • repositoryMetadata => (associative-array)

        Information about the newly created repository.

        • accountId => (string)

          The ID of the AWS account associated with the repository.

        • repositoryId => (string)

          The ID of the repository.

        • repositoryName => (string)

          The repository's name.

        • repositoryDescription => (string)

          A comment or description about the repository.

        • defaultBranch => (string)

          The repository's default branch name.

        • lastModifiedDate => (string)

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

        • creationDate => (string)

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

        • cloneUrlHttp => (string)

          The URL to use for cloning the repository over HTTPS.

        • cloneUrlSsh => (string)

          The URL to use for cloning the repository over SSH.

        • Arn => (string)

          The Amazon Resource Name (ARN) of the repository.


      # public Guzzle\Service\Resource\Model
      deleteRepository( array $args = array() )

      Executes the DeleteRepository operation.

      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.

      Examples

      • Basic formatting example
        $result = $client->deleteRepository(array(
            // repositoryName is required
            'repositoryName' => 'string',
        ));
        

      Parameters

      $args
      array
      $arg Associative array containing the following keys (required keys are bold):
      • repositoryName => (string)

        The name of the repository to delete.

      Returns

      Guzzle\Service\Resource\Model
      Returns a response Model object
      • repositoryId => (string)

        The ID of the repository that was deleted.


      # public Guzzle\Service\Resource\Model
      getBranch( array $args = array() )

      Executes the GetBranch operation.

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

      Examples

      • Basic formatting example
        $result = $client->getBranch(array(
            'repositoryName' => 'string',
            'branchName' => 'string',
        ));
        

      Parameters

      $args
      array
      $arg Associative array containing the following keys (required keys are bold):
      • repositoryName => (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.
      • branchName => (string)

        The name of the branch for which you want to retrieve information.

      Returns

      Guzzle\Service\Resource\Model
      Returns a response Model object
      • branch => (associative-array)

        The name of the branch.

        • branchName => (string)

          The name of the branch.

        • commitId => (string)

          The ID of the last commit made to the branch.


      # public Guzzle\Service\Resource\Model
      getRepository( array $args = array() )

      Executes the GetRepository operation.

      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.

      Examples

      • Basic formatting example
        $result = $client->getRepository(array(
            // repositoryName is required
            'repositoryName' => 'string',
        ));
        

      Parameters

      $args
      array
      $arg Associative array containing the following keys (required keys are bold):
      • repositoryName => (string)

        The name of the repository to get information about.

      Returns

      Guzzle\Service\Resource\Model
      Returns a response Model object
      • repositoryMetadata => (associative-array)

        Information about the repository.

        • accountId => (string)

          The ID of the AWS account associated with the repository.

        • repositoryId => (string)

          The ID of the repository.

        • repositoryName => (string)

          The repository's name.

        • repositoryDescription => (string)

          A comment or description about the repository.

        • defaultBranch => (string)

          The repository's default branch name.

        • lastModifiedDate => (string)

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

        • creationDate => (string)

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

        • cloneUrlHttp => (string)

          The URL to use for cloning the repository over HTTPS.

        • cloneUrlSsh => (string)

          The URL to use for cloning the repository over SSH.

        • Arn => (string)

          The Amazon Resource Name (ARN) of the repository.


      # public Guzzle\Service\Resource\Model
      listBranches( array $args = array() )

      Executes the ListBranches operation.

      Gets information about one or more branches in a repository.

      Examples

      • Basic formatting example
        $result = $client->listBranches(array(
            // repositoryName is required
            'repositoryName' => 'string',
            'nextToken' => 'string',
        ));
        

      Parameters

      $args
      array
      $arg Associative array containing the following keys (required keys are bold):
      • repositoryName => (string)

        The name of the repository that contains the branches.

      • nextToken => (string)

        An enumeration token that allows the operation to batch the results.

      Returns

      Guzzle\Service\Resource\Model
      Returns a response Model object
      • branches => (array<string>)

        The list of branch names.

      • nextToken => (string)

        An enumeration token that returns the batch of the results.


      # public Guzzle\Service\Resource\Model
      listRepositories( array $args = array() )

      Executes the ListRepositories operation.

      Gets information about one or more repositories.

      Examples

      • Basic formatting example
        $result = $client->listRepositories(array(
            'nextToken' => 'string',
            'sortBy' => 'string',
            'order' => 'string',
        ));
        

      Parameters

      $args
      array
      $arg Associative array containing the following keys (required keys are bold):
      • nextToken => (string)

        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.

      • sortBy => (string: repositoryName | lastModifiedDate )

        The criteria used to sort the results of a list repositories operation.

      • order => (string: ascending | descending )

        The order in which to sort the results of a list repositories operation.

      Returns

      Guzzle\Service\Resource\Model
      Returns a response Model object
      • repositories => (array<associative-array>)

        Lists the repositories called by the list repositories operation.

        • (associative-array)

          Information about a repository name and ID.

          • repositoryName => (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.
          • repositoryId => (string)

            The ID associated with the repository name.

      • nextToken => (string)

        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.


      # public Guzzle\Service\Resource\Model
      updateDefaultBranch( array $args = array() )

      Executes the UpdateDefaultBranch operation.

      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.

      Examples

      • Basic formatting example
        $result = $client->updateDefaultBranch(array(
            // repositoryName is required
            'repositoryName' => 'string',
            // defaultBranchName is required
            'defaultBranchName' => 'string',
        ));
        

      Parameters

      $args
      array
      $arg Associative array containing the following keys (required keys are bold):
      • repositoryName => (string)

        The name of the repository to set or change the default branch for.

      • defaultBranchName => (string)

        The name of the branch to set as the default.

      Returns

      Guzzle\Service\Resource\Model
      Returns a response Model object

        # public Guzzle\Service\Resource\Model
        updateRepositoryDescription( array $args = array() )

        Executes the UpdateRepositoryDescription operation.

        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.

        Examples

        • Basic formatting example
          $result = $client->updateRepositoryDescription(array(
              // repositoryName is required
              'repositoryName' => 'string',
              'repositoryDescription' => 'string',
          ));
          

        Parameters

        $args
        array
        $arg Associative array containing the following keys (required keys are bold):
        • repositoryName => (string)

          The name of the repository to set or change the comment or description for.

        • repositoryDescription => (string)

          The new comment or description for the specified repository.

        Returns

        Guzzle\Service\Resource\Model
        Returns a response Model object

          # public Guzzle\Service\Resource\Model
          updateRepositoryName( array $args = array() )

          Executes the UpdateRepositoryName operation.

          Renames a repository.

          Examples

          • Basic formatting example
            $result = $client->updateRepositoryName(array(
                // oldName is required
                'oldName' => 'string',
                // newName is required
                'newName' => 'string',
            ));
            

          Parameters

          $args
          array
          $arg Associative array containing the following keys (required keys are bold):
          • oldName => (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.
          • newName => (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.

          Returns

          Guzzle\Service\Resource\Model
          Returns a response Model object

            # public ResourceIteratorInterface
            getListBranchesIterator( array $args = array() )

            The input array uses the parameters of the ListBranches operation

            Parameters

            $args
            array
            $args

            Returns

            ResourceIteratorInterface
            # public ResourceIteratorInterface
            getListRepositoriesIterator( array $args = array() )

            The input array uses the parameters of the ListRepositories operation

            Parameters

            $args
            array
            $args

            Returns

            ResourceIteratorInterface

            Methods inherited from Aws\Common\Client\AbstractClient

            __call(), __construct(), createRequest(), getAllEvents(), getApiVersion(), getCredentials(), getRegion(), getRegions(), getSignature(), getWaiter(), getWaiterFactory(), send(), setCredentials(), setRegion(), setWaiterFactory(), waitUntil()

            Methods inherited from Guzzle\Service\Client

            execute(), executeMultiple(), getCommand(), getCommandFactory(), getDescription(), getInflector(), getIterator(), getResourceIteratorFactory(), prepareCommand(), setCommandFactory(), setDescription(), setInflector(), setResourceIteratorFactory()

            Methods inherited from Guzzle\Http\Client

            delete(), expandTemplate(), extractPharCacert(), get(), getBaseUrl(), getConfig(), getCurlMulti(), getDefaultOption(), getDefaultUserAgent(), getUriTemplate(), head(), initSsl(), options(), patch(), post(), prepareRequest(), put(), sendMultiple(), setBaseUrl(), setConfig(), setCurlMulti(), setDefaultOption(), setRequestFactory(), setSslVerification(), setUriTemplate(), setUserAgent()

            Methods inherited from Guzzle\Common\AbstractHasDispatcher

            addSubscriber(), dispatch(), getEventDispatcher(), setEventDispatcher()

            Magic methods summary

            Constants summary

            string LATEST_API_VERSION '2015-04-13'
            #

            Constants inherited from Guzzle\Service\Client

            COMMAND_PARAMS

            Constants inherited from Guzzle\Http\Client

            CURL_OPTIONS, DEFAULT_SELECT_TIMEOUT, DISABLE_REDIRECTS, MAX_HANDLES, REQUEST_OPTIONS, SSL_CERT_AUTHORITY

            Constants inherited from Guzzle\Http\ClientInterface

            CREATE_REQUEST, HTTP_DATE

            Properties summary

            Properties inherited from Aws\Common\Client\AbstractClient

            $aggregator, $credentials, $signature, $waiterFactory

            Properties inherited from Guzzle\Service\Client

            $commandFactory, $inflector, $resourceIteratorFactory, $serviceDescription

            Properties inherited from Guzzle\Http\Client

            $defaultHeaders, $requestFactory, $userAgent

            Properties inherited from Guzzle\Common\AbstractHasDispatcher

            $eventDispatcher

            AWS SDK for PHP API documentation generated by ApiGen 2.8.0