SDK for PHP 3.x

CodeCommitClient extends AwsClient
in package

This client is used to interact with the AWS CodeCommit service.

Supported API Versions

This class uses a service description model that is associated at runtime based on the version option given when constructing the client. The version option will determine which API operations, waiters, and paginators are available for a client. Creating a command or a specific API operation can be done using magic methods (e.g., $client->commandName(/** parameters */), or using the $client->getCommand method of the client.

Table of Contents

Methods

__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
associateApprovalRuleTemplateWithRepository()  : Result
associateApprovalRuleTemplateWithRepositoryAsync()  : Promise
batchAssociateApprovalRuleTemplateWithRepositories()  : Result
batchAssociateApprovalRuleTemplateWithRepositoriesAsync()  : Promise
batchDescribeMergeConflicts()  : Result
batchDescribeMergeConflictsAsync()  : Promise
batchDisassociateApprovalRuleTemplateFromRepositories()  : Result
batchDisassociateApprovalRuleTemplateFromRepositoriesAsync()  : Promise
batchGetCommits()  : Result
batchGetCommitsAsync()  : Promise
batchGetRepositories()  : Result
batchGetRepositoriesAsync()  : Promise
createApprovalRuleTemplate()  : Result
createApprovalRuleTemplateAsync()  : Promise
createBranch()  : Result
createBranchAsync()  : Promise
createCommit()  : Result
createCommitAsync()  : Promise
createPullRequest()  : Result
createPullRequestApprovalRule()  : Result
createPullRequestApprovalRuleAsync()  : Promise
createPullRequestAsync()  : Promise
createRepository()  : Result
createRepositoryAsync()  : Promise
createUnreferencedMergeCommit()  : Result
createUnreferencedMergeCommitAsync()  : Promise
deleteApprovalRuleTemplate()  : Result
deleteApprovalRuleTemplateAsync()  : Promise
deleteBranch()  : Result
deleteBranchAsync()  : Promise
deleteCommentContent()  : Result
deleteCommentContentAsync()  : Promise
deleteFile()  : Result
deleteFileAsync()  : Promise
deletePullRequestApprovalRule()  : Result
deletePullRequestApprovalRuleAsync()  : Promise
deleteRepository()  : Result
deleteRepositoryAsync()  : Promise
describeMergeConflicts()  : Result
describeMergeConflictsAsync()  : Promise
describePullRequestEvents()  : Result
describePullRequestEventsAsync()  : Promise
disassociateApprovalRuleTemplateFromRepository()  : Result
disassociateApprovalRuleTemplateFromRepositoryAsync()  : Promise
emitDeprecationWarning()  : mixed
evaluatePullRequestApprovalRules()  : Result
evaluatePullRequestApprovalRulesAsync()  : Promise
execute()  : mixed
executeAsync()  : mixed
factory()  : static
getApi()  : Service
getApprovalRuleTemplate()  : Result
getApprovalRuleTemplateAsync()  : Promise
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getBlob()  : Result
getBlobAsync()  : Promise
getBranch()  : Result
getBranchAsync()  : Promise
getClientBuiltIns()  : array<string|int, mixed>
Provides the set of built-in keys and values used for endpoint resolution
getClientContextParams()  : array<string|int, mixed>
Provides the set of service context parameter key-value pairs used for endpoint resolution.
getCommand()  : CommandInterface
getComment()  : Result
getCommentAsync()  : Promise
getCommentReactions()  : Result
getCommentReactionsAsync()  : Promise
getCommentsForComparedCommit()  : Result
getCommentsForComparedCommitAsync()  : Promise
getCommentsForPullRequest()  : Result
getCommentsForPullRequestAsync()  : Promise
getCommit()  : Result
getCommitAsync()  : Promise
getConfig()  : mixed|null
Get a client configuration value.
getCredentials()  : PromiseInterface
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
getDifferences()  : Result
getDifferencesAsync()  : Promise
getEndpoint()  : UriInterface
Gets the default endpoint, or base URL, used by the client.
getEndpointProvider()  : mixed
getEndpointProviderArgs()  : array<string|int, mixed>
Retrieves arguments to be used in endpoint resolution.
getFile()  : Result
getFileAsync()  : Promise
getFolder()  : Result
getFolderAsync()  : Promise
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getIterator()  : mixed
getMergeCommit()  : Result
getMergeCommitAsync()  : Promise
getMergeConflicts()  : Result
getMergeConflictsAsync()  : Promise
getMergeOptions()  : Result
getMergeOptionsAsync()  : Promise
getPaginator()  : mixed
getPullRequest()  : Result
getPullRequestApprovalStates()  : Result
getPullRequestApprovalStatesAsync()  : Promise
getPullRequestAsync()  : Promise
getPullRequestOverrideState()  : Result
getPullRequestOverrideStateAsync()  : Promise
getRegion()  : string
Get the region to which the client is configured to send requests.
getRepository()  : Result
getRepositoryAsync()  : Promise
getRepositoryTriggers()  : Result
getRepositoryTriggersAsync()  : Promise
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getWaiter()  : mixed
listApprovalRuleTemplates()  : Result
listApprovalRuleTemplatesAsync()  : Promise
listAssociatedApprovalRuleTemplatesForRepository()  : Result
listAssociatedApprovalRuleTemplatesForRepositoryAsync()  : Promise
listBranches()  : Result
listBranchesAsync()  : Promise
listFileCommitHistory()  : Result
listFileCommitHistoryAsync()  : Promise
listPullRequests()  : Result
listPullRequestsAsync()  : Promise
listRepositories()  : Result
listRepositoriesAsync()  : Promise
listRepositoriesForApprovalRuleTemplate()  : Result
listRepositoriesForApprovalRuleTemplateAsync()  : Promise
listTagsForResource()  : Result
listTagsForResourceAsync()  : Promise
mergeBranchesByFastForward()  : Result
mergeBranchesByFastForwardAsync()  : Promise
mergeBranchesBySquash()  : Result
mergeBranchesBySquashAsync()  : Promise
mergeBranchesByThreeWay()  : Result
mergeBranchesByThreeWayAsync()  : Promise
mergePullRequestByFastForward()  : Result
mergePullRequestByFastForwardAsync()  : Promise
mergePullRequestBySquash()  : Result
mergePullRequestBySquashAsync()  : Promise
mergePullRequestByThreeWay()  : Result
mergePullRequestByThreeWayAsync()  : Promise
overridePullRequestApprovalRules()  : Result
overridePullRequestApprovalRulesAsync()  : Promise
postCommentForComparedCommit()  : Result
postCommentForComparedCommitAsync()  : Promise
postCommentForPullRequest()  : Result
postCommentForPullRequestAsync()  : Promise
postCommentReply()  : Result
postCommentReplyAsync()  : Promise
putCommentReaction()  : Result
putCommentReactionAsync()  : Promise
putFile()  : Result
putFileAsync()  : Promise
putRepositoryTriggers()  : Result
putRepositoryTriggersAsync()  : Promise
tagResource()  : Result
tagResourceAsync()  : Promise
testRepositoryTriggers()  : Result
testRepositoryTriggersAsync()  : Promise
untagResource()  : Result
untagResourceAsync()  : Promise
updateApprovalRuleTemplateContent()  : Result
updateApprovalRuleTemplateContentAsync()  : Promise
updateApprovalRuleTemplateDescription()  : Result
updateApprovalRuleTemplateDescriptionAsync()  : Promise
updateApprovalRuleTemplateName()  : Result
updateApprovalRuleTemplateNameAsync()  : Promise
updateComment()  : Result
updateCommentAsync()  : Promise
updateDefaultBranch()  : Result
updateDefaultBranchAsync()  : Promise
updatePullRequestApprovalRuleContent()  : Result
updatePullRequestApprovalRuleContentAsync()  : Promise
updatePullRequestApprovalState()  : Result
updatePullRequestApprovalStateAsync()  : Promise
updatePullRequestDescription()  : Result
updatePullRequestDescriptionAsync()  : Promise
updatePullRequestStatus()  : Result
updatePullRequestStatusAsync()  : Promise
updatePullRequestTitle()  : Result
updatePullRequestTitleAsync()  : Promise
updateRepositoryDescription()  : Result
updateRepositoryDescriptionAsync()  : Promise
updateRepositoryEncryptionKey()  : Result
updateRepositoryEncryptionKeyAsync()  : Promise
updateRepositoryName()  : Result
updateRepositoryNameAsync()  : Promise
waitUntil()  : mixed

Methods

__call()

public __call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed>

__construct()

The client constructor accepts the following options:

public __construct(array<string|int, mixed> $args) : mixed
  • api_provider: (callable) An optional PHP callable that accepts a type, service, and version argument, and returns an array of corresponding configuration data. The type value can be one of api, waiter, or paginator.
  • credentials: (Aws\Credentials\CredentialsInterface|array|bool|callable) Specifies the credentials used to sign requests. Provide an Aws\Credentials\CredentialsInterface object, an associative array of "key", "secret", and an optional "token" key, false to use null credentials, or a callable credentials provider used to create credentials or return null. See Aws\Credentials\CredentialProvider for a list of built-in credentials providers. If no credentials are provided, the SDK will attempt to load them from the environment.
  • token: (Aws\Token\TokenInterface|array|bool|callable) Specifies the token used to authorize requests. Provide an Aws\Token\TokenInterface object, an associative array of "token" and an optional "expires" key, false to use no token, or a callable token provider used to create a token or return null. See Aws\Token\TokenProvider for a list of built-in token providers. If no token is provided, the SDK will attempt to load one from the environment.
  • csm: (Aws\ClientSideMonitoring\ConfigurationInterface|array|callable) Specifies the credentials used to sign requests. Provide an Aws\ClientSideMonitoring\ConfigurationInterface object, a callable configuration provider used to create client-side monitoring configuration, false to disable csm, or an associative array with the following keys: enabled: (bool) Set to true to enable client-side monitoring, defaults to false; host: (string) the host location to send monitoring events to, defaults to 127.0.0.1; port: (int) The port used for the host connection, defaults to 31000; client_id: (string) An identifier for this project
  • debug: (bool|array) Set to true to display debug information when sending requests. Alternatively, you can provide an associative array with the following keys: logfn: (callable) Function that is invoked with log messages; stream_size: (int) When the size of a stream is greater than this number, the stream data will not be logged (set to "0" to not log any stream data); scrub_auth: (bool) Set to false to disable the scrubbing of auth data from the logged messages; http: (bool) Set to false to disable the "debug" feature of lower level HTTP adapters (e.g., verbose curl output).
  • stats: (bool|array) Set to true to gather transfer statistics on requests sent. Alternatively, you can provide an associative array with the following keys: retries: (bool) Set to false to disable reporting on retries attempted; http: (bool) Set to true to enable collecting statistics from lower level HTTP adapters (e.g., values returned in GuzzleHttp\TransferStats). HTTP handlers must support an http_stats_receiver option for this to have an effect; timer: (bool) Set to true to enable a command timer that reports the total wall clock time spent on an operation in seconds.
  • disable_host_prefix_injection: (bool) Set to true to disable host prefix injection logic for services that use it. This disables the entire prefix injection, including the portions supplied by user-defined parameters. Setting this flag will have no effect on services that do not use host prefix injection.
  • endpoint: (string) The full URI of the webservice. This is only required when connecting to a custom endpoint (e.g., a local version of S3).
  • endpoint_discovery: (Aws\EndpointDiscovery\ConfigurationInterface, Aws\CacheInterface, array, callable) Settings for endpoint discovery. Provide an instance of Aws\EndpointDiscovery\ConfigurationInterface, an instance Aws\CacheInterface, a callable that provides a promise for a Configuration object, or an associative array with the following keys: enabled: (bool) Set to true to enable endpoint discovery, false to explicitly disable it, defaults to false; cache_limit: (int) The maximum number of keys in the endpoints cache, defaults to 1000.
  • endpoint_provider: (callable) An optional PHP callable that accepts a hash of options including a "service" and "region" key and returns NULL or a hash of endpoint data, of which the "endpoint" key is required. See Aws\Endpoint\EndpointProvider for a list of built-in providers.
  • handler: (callable) A handler that accepts a command object, request object and returns a promise that is fulfilled with an Aws\ResultInterface object or rejected with an Aws\Exception\AwsException. A handler does not accept a next handler as it is terminal and expected to fulfill a command. If no handler is provided, a default Guzzle handler will be utilized.
  • http: (array, default=array(0)) Set to an array of SDK request options to apply to each request (e.g., proxy, verify, etc.).
  • http_handler: (callable) An HTTP handler is a function that accepts a PSR-7 request object and returns a promise that is fulfilled with a PSR-7 response object or rejected with an array of exception data. NOTE: This option supersedes any provided "handler" option.
  • idempotency_auto_fill: (bool|callable) Set to false to disable SDK to populate parameters that enabled 'idempotencyToken' trait with a random UUID v4 value on your behalf. Using default value 'true' still allows parameter value to be overwritten when provided. Note: auto-fill only works when cryptographically secure random bytes generator functions (random_bytes, openssl_random_pseudo_bytes or mcrypt_create_iv) can be found. You may also provide a callable source of random bytes.
  • profile: (string) Allows you to specify which profile to use when credentials are created from the AWS credentials file in your HOME directory. This setting overrides the AWS_PROFILE environment variable. Note: Specifying "profile" will cause the "credentials" key to be ignored.
  • region: (string, required) Region to connect to. See http://docs.aws.amazon.com/general/latest/gr/rande.html for a list of available regions.
  • retries: (int, Aws\Retry\ConfigurationInterface, Aws\CacheInterface, array, callable) Configures the retry mode and maximum number of allowed retries for a client (pass 0 to disable retries). Provide an integer for 'legacy' mode with the specified number of retries. Otherwise provide an instance of Aws\Retry\ConfigurationInterface, an instance of Aws\CacheInterface, a callable function, or an array with the following keys: mode: (string) Set to 'legacy', 'standard' (uses retry quota management), or 'adapative' (an experimental mode that adds client-side rate limiting to standard mode); max_attempts (int) The maximum number of attempts for a given request.
  • scheme: (string, default=string(5) "https") URI scheme to use when connecting connect. The SDK will utilize "https" endpoints (i.e., utilize SSL/TLS connections) by default. You can attempt to connect to a service over an unencrypted "http" endpoint by setting scheme to "http".
  • signature_provider: (callable) A callable that accepts a signature version name (e.g., "v4"), a service name, and region, and returns a SignatureInterface object or null. This provider is used to create signers utilized by the client. See Aws\Signature\SignatureProvider for a list of built-in providers
  • signature_version: (string) A string representing a custom signature version to use with a service (e.g., v4). Note that per/operation signature version MAY override this requested signature version.
  • use_aws_shared_config_files: (bool, default=bool(true)) Set to false to disable checking for shared config file in '~/.aws/config' and '~/.aws/credentials'. This will override the AWS_CONFIG_FILE environment variable.
  • validate: (bool, default=bool(true)) Set to false to disable client-side parameter validation.
  • version: (string, required) The version of the webservice to utilize (e.g., 2006-03-01).
  • ua_append: (string, array) To pass custom user agent parameters.
  • app_id: (string) an optional application specific identifier that can be set. When set it will be appended to the User-Agent header of every request in the form of App/{AppId}. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id. See https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html for more information on environment variables and shared config settings.
Parameters
$args : array<string|int, mixed>

Client configuration arguments.

Tags
throws
InvalidArgumentException

if any required options are missing or the service is not supported.

__sleep()

public __sleep() : mixed

associateApprovalRuleTemplateWithRepository()

public associateApprovalRuleTemplateWithRepository(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

associateApprovalRuleTemplateWithRepositoryAsync()

public associateApprovalRuleTemplateWithRepositoryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

batchAssociateApprovalRuleTemplateWithRepositories()

public batchAssociateApprovalRuleTemplateWithRepositories(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

batchAssociateApprovalRuleTemplateWithRepositoriesAsync()

public batchAssociateApprovalRuleTemplateWithRepositoriesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

batchDescribeMergeConflicts()

public batchDescribeMergeConflicts(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

batchDescribeMergeConflictsAsync()

public batchDescribeMergeConflictsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

batchDisassociateApprovalRuleTemplateFromRepositories()

public batchDisassociateApprovalRuleTemplateFromRepositories(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

batchDisassociateApprovalRuleTemplateFromRepositoriesAsync()

public batchDisassociateApprovalRuleTemplateFromRepositoriesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

batchGetCommits()

public batchGetCommits(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

batchGetCommitsAsync()

public batchGetCommitsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

batchGetRepositories()

public batchGetRepositories(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

batchGetRepositoriesAsync()

public batchGetRepositoriesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

createApprovalRuleTemplate()

public createApprovalRuleTemplate(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

createApprovalRuleTemplateAsync()

public createApprovalRuleTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

createBranch()

public createBranch(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

createBranchAsync()

public createBranchAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

createCommit()

public createCommit(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

createCommitAsync()

public createCommitAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

createPullRequest()

public createPullRequest(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

createPullRequestApprovalRule()

public createPullRequestApprovalRule(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

createPullRequestApprovalRuleAsync()

public createPullRequestApprovalRuleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

createPullRequestAsync()

public createPullRequestAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

createRepository()

public createRepository(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

createRepositoryAsync()

public createRepositoryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

createUnreferencedMergeCommit()

public createUnreferencedMergeCommit(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

createUnreferencedMergeCommitAsync()

public createUnreferencedMergeCommitAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteApprovalRuleTemplate()

public deleteApprovalRuleTemplate(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteApprovalRuleTemplateAsync()

public deleteApprovalRuleTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteBranch()

public deleteBranch(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteBranchAsync()

public deleteBranchAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteCommentContent()

public deleteCommentContent(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteCommentContentAsync()

public deleteCommentContentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteFile()

public deleteFile(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteFileAsync()

public deleteFileAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deletePullRequestApprovalRule()

public deletePullRequestApprovalRule(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deletePullRequestApprovalRuleAsync()

public deletePullRequestApprovalRuleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteRepository()

public deleteRepository(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteRepositoryAsync()

public deleteRepositoryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

describeMergeConflicts()

public describeMergeConflicts(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

describeMergeConflictsAsync()

public describeMergeConflictsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

describePullRequestEvents()

public describePullRequestEvents(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

describePullRequestEventsAsync()

public describePullRequestEventsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

disassociateApprovalRuleTemplateFromRepository()

public disassociateApprovalRuleTemplateFromRepository(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

disassociateApprovalRuleTemplateFromRepositoryAsync()

public disassociateApprovalRuleTemplateFromRepositoryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

emitDeprecationWarning()

public static emitDeprecationWarning() : mixed

evaluatePullRequestApprovalRules()

public evaluatePullRequestApprovalRules(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

evaluatePullRequestApprovalRulesAsync()

public evaluatePullRequestApprovalRulesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

factory()

public static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
$config : array<string|int, mixed> = []
Tags
deprecated
Return values
static

getApprovalRuleTemplate()

public getApprovalRuleTemplate(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getApprovalRuleTemplateAsync()

public getApprovalRuleTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getArguments()

Get an array of client constructor arguments used by the client.

public static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed>

getBlob()

public getBlob(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getBlobAsync()

public getBlobAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getBranch()

public getBranch(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getBranchAsync()

public getBranchAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getClientBuiltIns()

Provides the set of built-in keys and values used for endpoint resolution

public getClientBuiltIns() : array<string|int, mixed>
Return values
array<string|int, mixed>

getClientContextParams()

Provides the set of service context parameter key-value pairs used for endpoint resolution.

public getClientContextParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCommand()

public abstract getCommand(string $name[, array<string|int, mixed> $args = [] ]) : CommandInterface
Parameters
$name : string
$args : array<string|int, mixed> = []
Return values
CommandInterface

getComment()

public getComment(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getCommentAsync()

public getCommentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getCommentReactions()

public getCommentReactions(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getCommentReactionsAsync()

public getCommentReactionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getCommentsForComparedCommit()

public getCommentsForComparedCommit(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getCommentsForComparedCommitAsync()

public getCommentsForComparedCommitAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getCommentsForPullRequest()

public getCommentsForPullRequest(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getCommentsForPullRequestAsync()

public getCommentsForPullRequestAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getCommit()

public getCommit(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getCommitAsync()

public getCommitAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getConfig()

Get a client configuration value.

public getConfig([mixed $option = null ]) : mixed|null
Parameters
$option : mixed = null

The option to retrieve. Pass null to retrieve all options.

Return values
mixed|null

getCredentials()

Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.

public getCredentials() : PromiseInterface

If you need the credentials synchronously, then call the wait() method on the returned promise.

Return values
PromiseInterface

getDifferences()

public getDifferences(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getDifferencesAsync()

public getDifferencesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getEndpoint()

Gets the default endpoint, or base URL, used by the client.

public getEndpoint() : UriInterface
Return values
UriInterface

getEndpointProvider()

public getEndpointProvider() : mixed

getEndpointProviderArgs()

Retrieves arguments to be used in endpoint resolution.

public getEndpointProviderArgs() : array<string|int, mixed>
Return values
array<string|int, mixed>

getFile()

public getFile(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getFileAsync()

public getFileAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getFolder()

public getFolder(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getFolderAsync()

public getFolderAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getHandlerList()

Get the handler list used to transfer commands.

public getHandlerList() : HandlerList

This list can be modified to add middleware or to change the underlying handler used to send HTTP requests.

Return values
HandlerList

getIterator()

public getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []

getMergeCommit()

public getMergeCommit(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getMergeCommitAsync()

public getMergeCommitAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getMergeConflicts()

public getMergeConflicts(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getMergeConflictsAsync()

public getMergeConflictsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getMergeOptions()

public getMergeOptions(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getMergeOptionsAsync()

public getMergeOptionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getPaginator()

public getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []

getPullRequest()

public getPullRequest(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getPullRequestApprovalStates()

public getPullRequestApprovalStates(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getPullRequestApprovalStatesAsync()

public getPullRequestApprovalStatesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getPullRequestAsync()

public getPullRequestAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getPullRequestOverrideState()

public getPullRequestOverrideState(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getPullRequestOverrideStateAsync()

public getPullRequestOverrideStateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getRegion()

Get the region to which the client is configured to send requests.

public getRegion() : string
Return values
string

getRepository()

public getRepository(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getRepositoryAsync()

public getRepositoryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getRepositoryTriggers()

public getRepositoryTriggers(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getRepositoryTriggersAsync()

public getRepositoryTriggersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable

getWaiter()

public getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []

listApprovalRuleTemplates()

public listApprovalRuleTemplates(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listApprovalRuleTemplatesAsync()

public listApprovalRuleTemplatesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listAssociatedApprovalRuleTemplatesForRepository()

public listAssociatedApprovalRuleTemplatesForRepository(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listAssociatedApprovalRuleTemplatesForRepositoryAsync()

public listAssociatedApprovalRuleTemplatesForRepositoryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listBranches()

public listBranches(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listBranchesAsync()

public listBranchesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listFileCommitHistory()

public listFileCommitHistory(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listFileCommitHistoryAsync()

public listFileCommitHistoryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listPullRequests()

public listPullRequests(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listPullRequestsAsync()

public listPullRequestsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listRepositories()

public listRepositories(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listRepositoriesAsync()

public listRepositoriesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listRepositoriesForApprovalRuleTemplate()

public listRepositoriesForApprovalRuleTemplate(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listRepositoriesForApprovalRuleTemplateAsync()

public listRepositoriesForApprovalRuleTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listTagsForResource()

public listTagsForResource(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listTagsForResourceAsync()

public listTagsForResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

mergeBranchesByFastForward()

public mergeBranchesByFastForward(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

mergeBranchesByFastForwardAsync()

public mergeBranchesByFastForwardAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

mergeBranchesBySquash()

public mergeBranchesBySquash(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

mergeBranchesBySquashAsync()

public mergeBranchesBySquashAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

mergeBranchesByThreeWay()

public mergeBranchesByThreeWay(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

mergeBranchesByThreeWayAsync()

public mergeBranchesByThreeWayAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

mergePullRequestByFastForward()

public mergePullRequestByFastForward(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

mergePullRequestByFastForwardAsync()

public mergePullRequestByFastForwardAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

mergePullRequestBySquash()

public mergePullRequestBySquash(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

mergePullRequestBySquashAsync()

public mergePullRequestBySquashAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

mergePullRequestByThreeWay()

public mergePullRequestByThreeWay(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

mergePullRequestByThreeWayAsync()

public mergePullRequestByThreeWayAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

overridePullRequestApprovalRules()

public overridePullRequestApprovalRules(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

overridePullRequestApprovalRulesAsync()

public overridePullRequestApprovalRulesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

postCommentForComparedCommit()

public postCommentForComparedCommit(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

postCommentForComparedCommitAsync()

public postCommentForComparedCommitAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

postCommentForPullRequest()

public postCommentForPullRequest(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

postCommentForPullRequestAsync()

public postCommentForPullRequestAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

postCommentReply()

public postCommentReply(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

postCommentReplyAsync()

public postCommentReplyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

putCommentReaction()

public putCommentReaction(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

putCommentReactionAsync()

public putCommentReactionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

putFile()

public putFile(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

putFileAsync()

public putFileAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

putRepositoryTriggers()

public putRepositoryTriggers(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

putRepositoryTriggersAsync()

public putRepositoryTriggersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

tagResource()

public tagResource(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

tagResourceAsync()

public tagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

testRepositoryTriggers()

public testRepositoryTriggers(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

testRepositoryTriggersAsync()

public testRepositoryTriggersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

untagResource()

public untagResource(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

untagResourceAsync()

public untagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updateApprovalRuleTemplateContent()

public updateApprovalRuleTemplateContent(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updateApprovalRuleTemplateContentAsync()

public updateApprovalRuleTemplateContentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updateApprovalRuleTemplateDescription()

public updateApprovalRuleTemplateDescription(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updateApprovalRuleTemplateDescriptionAsync()

public updateApprovalRuleTemplateDescriptionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updateApprovalRuleTemplateName()

public updateApprovalRuleTemplateName(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updateApprovalRuleTemplateNameAsync()

public updateApprovalRuleTemplateNameAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updateComment()

public updateComment(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updateCommentAsync()

public updateCommentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updateDefaultBranch()

public updateDefaultBranch(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updateDefaultBranchAsync()

public updateDefaultBranchAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updatePullRequestApprovalRuleContent()

public updatePullRequestApprovalRuleContent(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updatePullRequestApprovalRuleContentAsync()

public updatePullRequestApprovalRuleContentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updatePullRequestApprovalState()

public updatePullRequestApprovalState(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updatePullRequestApprovalStateAsync()

public updatePullRequestApprovalStateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updatePullRequestDescription()

public updatePullRequestDescription(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updatePullRequestDescriptionAsync()

public updatePullRequestDescriptionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updatePullRequestStatus()

public updatePullRequestStatus(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updatePullRequestStatusAsync()

public updatePullRequestStatusAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updatePullRequestTitle()

public updatePullRequestTitle(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updatePullRequestTitleAsync()

public updatePullRequestTitleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updateRepositoryDescription()

public updateRepositoryDescription(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updateRepositoryDescriptionAsync()

public updateRepositoryDescriptionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updateRepositoryEncryptionKey()

public updateRepositoryEncryptionKey(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updateRepositoryEncryptionKeyAsync()

public updateRepositoryEncryptionKeyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updateRepositoryName()

public updateRepositoryName(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updateRepositoryNameAsync()

public updateRepositoryNameAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

waitUntil()

public waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
On this page