CodeCommitClient
extends AwsClient
in package
This client is used to interact with the **AWS CodeCommit** service.
Table of Contents
- $aliases : array<string|int, mixed>
- $api : Service
- $config : array<string|int, mixed>
- $credentialProvider : callable
- $defaultRequestOptions : array<string|int, mixed>
- $endpoint : string
- $handlerList : HandlerList
- $region : string
- $signatureProvider : callable
- __call() : mixed
- __construct() : mixed
- The client constructor accepts the following options:
- __sleep() : mixed
- associateApprovalRuleTemplateWithRepository() :
- associateApprovalRuleTemplateWithRepositoryAsync() :
- batchAssociateApprovalRuleTemplateWithRepositories() :
- batchAssociateApprovalRuleTemplateWithRepositoriesAsync() :
- batchDescribeMergeConflicts() :
- batchDescribeMergeConflictsAsync() :
- batchDisassociateApprovalRuleTemplateFromRepositories() :
- batchDisassociateApprovalRuleTemplateFromRepositoriesAsync() :
- batchGetCommits() :
- batchGetCommitsAsync() :
- batchGetRepositories() :
- batchGetRepositoriesAsync() :
- createApprovalRuleTemplate() :
- createApprovalRuleTemplateAsync() :
- createBranch() :
- createBranchAsync() :
- createCommit() :
- createCommitAsync() :
- createPullRequest() :
- createPullRequestApprovalRule() :
- createPullRequestApprovalRuleAsync() :
- createPullRequestAsync() :
- createRepository() :
- createRepositoryAsync() :
- createUnreferencedMergeCommit() :
- createUnreferencedMergeCommitAsync() :
- deleteApprovalRuleTemplate() :
- deleteApprovalRuleTemplateAsync() :
- deleteBranch() :
- deleteBranchAsync() :
- deleteCommentContent() :
- deleteCommentContentAsync() :
- deleteFile() :
- deleteFileAsync() :
- deletePullRequestApprovalRule() :
- deletePullRequestApprovalRuleAsync() :
- deleteRepository() :
- deleteRepositoryAsync() :
- describeMergeConflicts() :
- describeMergeConflictsAsync() :
- describePullRequestEvents() :
- describePullRequestEventsAsync() :
- disassociateApprovalRuleTemplateFromRepository() :
- disassociateApprovalRuleTemplateFromRepositoryAsync() :
- evaluatePullRequestApprovalRules() :
- evaluatePullRequestApprovalRulesAsync() :
- execute() : mixed
- executeAsync() : mixed
- factory() : static
- getApi() : Service
- getApprovalRuleTemplate() :
- getApprovalRuleTemplateAsync() :
- getArguments() : array<string|int, mixed>
- Get an array of client constructor arguments used by the client.
- getBlob() :
- getBlobAsync() :
- getBranch() :
- getBranchAsync() :
- getCommand() : CommandInterface
- getComment() :
- getCommentAsync() :
- getCommentReactions() :
- getCommentReactionsAsync() :
- getCommentsForComparedCommit() :
- getCommentsForComparedCommitAsync() :
- getCommentsForPullRequest() :
- getCommentsForPullRequestAsync() :
- getCommit() :
- getCommitAsync() :
- getConfig() : mixed|null
- Get a client configuration value.
- getCredentials() : PromiseInterface
- Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
- getDifferences() :
- getDifferencesAsync() :
- getEndpoint() : UriInterface
- Gets the default endpoint, or base URL, used by the client.
- getFile() :
- getFileAsync() :
- getFolder() :
- getFolderAsync() :
- getHandlerList() : HandlerList
- Get the handler list used to transfer commands.
- getIterator() : mixed
- getMergeCommit() :
- getMergeCommitAsync() :
- getMergeConflicts() :
- getMergeConflictsAsync() :
- getMergeOptions() :
- getMergeOptionsAsync() :
- getPaginator() : mixed
- getPullRequest() :
- getPullRequestApprovalStates() :
- getPullRequestApprovalStatesAsync() :
- getPullRequestAsync() :
- getPullRequestOverrideState() :
- getPullRequestOverrideStateAsync() :
- getRegion() : string
- Get the region to which the client is configured to send requests.
- getRepository() :
- getRepositoryAsync() :
- getRepositoryTriggers() :
- getRepositoryTriggersAsync() :
- getSignatureProvider() : callable
- Get the signature_provider function of the client.
- getWaiter() : mixed
- listApprovalRuleTemplates() :
- listApprovalRuleTemplatesAsync() :
- listAssociatedApprovalRuleTemplatesForRepository() :
- listAssociatedApprovalRuleTemplatesForRepositoryAsync() :
- listBranches() :
- listBranchesAsync() :
- listPullRequests() :
- listPullRequestsAsync() :
- listRepositories() :
- listRepositoriesAsync() :
- listRepositoriesForApprovalRuleTemplate() :
- listRepositoriesForApprovalRuleTemplateAsync() :
- listTagsForResource() :
- listTagsForResourceAsync() :
- mergeBranchesByFastForward() :
- mergeBranchesByFastForwardAsync() :
- mergeBranchesBySquash() :
- mergeBranchesBySquashAsync() :
- mergeBranchesByThreeWay() :
- mergeBranchesByThreeWayAsync() :
- mergePullRequestByFastForward() :
- mergePullRequestByFastForwardAsync() :
- mergePullRequestBySquash() :
- mergePullRequestBySquashAsync() :
- mergePullRequestByThreeWay() :
- mergePullRequestByThreeWayAsync() :
- overridePullRequestApprovalRules() :
- overridePullRequestApprovalRulesAsync() :
- postCommentForComparedCommit() :
- postCommentForComparedCommitAsync() :
- postCommentForPullRequest() :
- postCommentForPullRequestAsync() :
- postCommentReply() :
- postCommentReplyAsync() :
- putCommentReaction() :
- putCommentReactionAsync() :
- putFile() :
- putFileAsync() :
- putRepositoryTriggers() :
- putRepositoryTriggersAsync() :
- tagResource() :
- tagResourceAsync() :
- testRepositoryTriggers() :
- testRepositoryTriggersAsync() :
- untagResource() :
- untagResourceAsync() :
- updateApprovalRuleTemplateContent() :
- updateApprovalRuleTemplateContentAsync() :
- updateApprovalRuleTemplateDescription() :
- updateApprovalRuleTemplateDescriptionAsync() :
- updateApprovalRuleTemplateName() :
- updateApprovalRuleTemplateNameAsync() :
- updateComment() :
- updateCommentAsync() :
- updateDefaultBranch() :
- updateDefaultBranchAsync() :
- updatePullRequestApprovalRuleContent() :
- updatePullRequestApprovalRuleContentAsync() :
- updatePullRequestApprovalState() :
- updatePullRequestApprovalStateAsync() :
- updatePullRequestDescription() :
- updatePullRequestDescriptionAsync() :
- updatePullRequestStatus() :
- updatePullRequestStatusAsync() :
- updatePullRequestTitle() :
- updatePullRequestTitleAsync() :
- updateRepositoryDescription() :
- updateRepositoryDescriptionAsync() :
- updateRepositoryName() :
- updateRepositoryNameAsync() :
- waitUntil() : mixed
- addEndpointDiscoveryMiddleware() : mixed
- addEndpointParameterMiddleware() : mixed
- addInvocationId() : mixed
- addSignatureMiddleware() : mixed
- addStreamRequestPayload() : mixed
- loadAliases() : mixed
- parseClass() : array<string|int, mixed>
- Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".
Properties
$aliases
private
array<string|int, mixed>
$aliases
$api
private
Service
$api
$config
private
array<string|int, mixed>
$config
$credentialProvider
private
callable
$credentialProvider
$defaultRequestOptions
private
array<string|int, mixed>
$defaultRequestOptions
$endpoint
private
string
$endpoint
$handlerList
private
HandlerList
$handlerList
$region
private
string
$region
$signatureProvider
private
callable
$signatureProvider
Methods
__call()
public
__call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed>
Return values
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,
falseto 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. - 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,
falseto 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_receiveroption 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
schemeto "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).
Parameters
- $args : array<string|int, mixed>
-
Client configuration arguments.
Tags
Return values
mixed —__sleep()
public
__sleep() : mixed
Return values
mixed —associateApprovalRuleTemplateWithRepository()
public
associateApprovalRuleTemplateWithRepository(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—associateApprovalRuleTemplateWithRepositoryAsync()
public
associateApprovalRuleTemplateWithRepositoryAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—batchAssociateApprovalRuleTemplateWithRepositories()
public
batchAssociateApprovalRuleTemplateWithRepositories(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—batchAssociateApprovalRuleTemplateWithRepositoriesAsync()
public
batchAssociateApprovalRuleTemplateWithRepositoriesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—batchDescribeMergeConflicts()
public
batchDescribeMergeConflicts(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—batchDescribeMergeConflictsAsync()
public
batchDescribeMergeConflictsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—batchDisassociateApprovalRuleTemplateFromRepositories()
public
batchDisassociateApprovalRuleTemplateFromRepositories(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—batchDisassociateApprovalRuleTemplateFromRepositoriesAsync()
public
batchDisassociateApprovalRuleTemplateFromRepositoriesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—batchGetCommits()
public
batchGetCommits(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—batchGetCommitsAsync()
public
batchGetCommitsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—batchGetRepositories()
public
batchGetRepositories(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—batchGetRepositoriesAsync()
public
batchGetRepositoriesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createApprovalRuleTemplate()
public
createApprovalRuleTemplate(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createApprovalRuleTemplateAsync()
public
createApprovalRuleTemplateAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createBranch()
public
createBranch(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createBranchAsync()
public
createBranchAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createCommit()
public
createCommit(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createCommitAsync()
public
createCommitAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createPullRequest()
public
createPullRequest(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createPullRequestApprovalRule()
public
createPullRequestApprovalRule(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createPullRequestApprovalRuleAsync()
public
createPullRequestApprovalRuleAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createPullRequestAsync()
public
createPullRequestAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createRepository()
public
createRepository(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createRepositoryAsync()
public
createRepositoryAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createUnreferencedMergeCommit()
public
createUnreferencedMergeCommit(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createUnreferencedMergeCommitAsync()
public
createUnreferencedMergeCommitAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteApprovalRuleTemplate()
public
deleteApprovalRuleTemplate(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteApprovalRuleTemplateAsync()
public
deleteApprovalRuleTemplateAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteBranch()
public
deleteBranch(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteBranchAsync()
public
deleteBranchAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteCommentContent()
public
deleteCommentContent(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteCommentContentAsync()
public
deleteCommentContentAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteFile()
public
deleteFile(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteFileAsync()
public
deleteFileAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deletePullRequestApprovalRule()
public
deletePullRequestApprovalRule(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deletePullRequestApprovalRuleAsync()
public
deletePullRequestApprovalRuleAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteRepository()
public
deleteRepository(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteRepositoryAsync()
public
deleteRepositoryAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeMergeConflicts()
public
describeMergeConflicts(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeMergeConflictsAsync()
public
describeMergeConflictsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describePullRequestEvents()
public
describePullRequestEvents(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describePullRequestEventsAsync()
public
describePullRequestEventsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateApprovalRuleTemplateFromRepository()
public
disassociateApprovalRuleTemplateFromRepository(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateApprovalRuleTemplateFromRepositoryAsync()
public
disassociateApprovalRuleTemplateFromRepositoryAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—evaluatePullRequestApprovalRules()
public
evaluatePullRequestApprovalRules(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—evaluatePullRequestApprovalRulesAsync()
public
evaluatePullRequestApprovalRulesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—execute()
public
execute(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
Return values
mixed —executeAsync()
public
executeAsync(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
Return values
mixed —factory()
public
static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
- $config : array<string|int, mixed> = []
Tags
Return values
static —getApi()
public
abstract getApi() : Service
Return values
Service —getApprovalRuleTemplate()
public
getApprovalRuleTemplate(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getApprovalRuleTemplateAsync()
public
getApprovalRuleTemplateAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—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 = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getBlobAsync()
public
getBlobAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getBranch()
public
getBranch(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getBranchAsync()
public
getBranchAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—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 = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getCommentAsync()
public
getCommentAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getCommentReactions()
public
getCommentReactions(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getCommentReactionsAsync()
public
getCommentReactionsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getCommentsForComparedCommit()
public
getCommentsForComparedCommit(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getCommentsForComparedCommitAsync()
public
getCommentsForComparedCommitAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getCommentsForPullRequest()
public
getCommentsForPullRequest(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getCommentsForPullRequestAsync()
public
getCommentsForPullRequestAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getCommit()
public
getCommit(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getCommitAsync()
public
getCommitAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—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 = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getDifferencesAsync()
public
getDifferencesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getEndpoint()
Gets the default endpoint, or base URL, used by the client.
public
getEndpoint() : UriInterface
Return values
UriInterface —getFile()
public
getFile(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getFileAsync()
public
getFileAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getFolder()
public
getFolder(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getFolderAsync()
public
getFolderAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—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> = []
Return values
mixed —getMergeCommit()
public
getMergeCommit(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getMergeCommitAsync()
public
getMergeCommitAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getMergeConflicts()
public
getMergeConflicts(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getMergeConflictsAsync()
public
getMergeConflictsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getMergeOptions()
public
getMergeOptions(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getMergeOptionsAsync()
public
getMergeOptionsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getPaginator()
public
getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Return values
mixed —getPullRequest()
public
getPullRequest(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getPullRequestApprovalStates()
public
getPullRequestApprovalStates(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getPullRequestApprovalStatesAsync()
public
getPullRequestApprovalStatesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getPullRequestAsync()
public
getPullRequestAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getPullRequestOverrideState()
public
getPullRequestOverrideState(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getPullRequestOverrideStateAsync()
public
getPullRequestOverrideStateAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—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 = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getRepositoryAsync()
public
getRepositoryAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getRepositoryTriggers()
public
getRepositoryTriggers(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getRepositoryTriggersAsync()
public
getRepositoryTriggersAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—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> = []
Return values
mixed —listApprovalRuleTemplates()
public
listApprovalRuleTemplates(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listApprovalRuleTemplatesAsync()
public
listApprovalRuleTemplatesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listAssociatedApprovalRuleTemplatesForRepository()
public
listAssociatedApprovalRuleTemplatesForRepository(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listAssociatedApprovalRuleTemplatesForRepositoryAsync()
public
listAssociatedApprovalRuleTemplatesForRepositoryAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listBranches()
public
listBranches(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listBranchesAsync()
public
listBranchesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listPullRequests()
public
listPullRequests(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listPullRequestsAsync()
public
listPullRequestsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listRepositories()
public
listRepositories(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listRepositoriesAsync()
public
listRepositoriesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listRepositoriesForApprovalRuleTemplate()
public
listRepositoriesForApprovalRuleTemplate(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listRepositoriesForApprovalRuleTemplateAsync()
public
listRepositoriesForApprovalRuleTemplateAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTagsForResource()
public
listTagsForResource(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTagsForResourceAsync()
public
listTagsForResourceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—mergeBranchesByFastForward()
public
mergeBranchesByFastForward(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—mergeBranchesByFastForwardAsync()
public
mergeBranchesByFastForwardAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—mergeBranchesBySquash()
public
mergeBranchesBySquash(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—mergeBranchesBySquashAsync()
public
mergeBranchesBySquashAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—mergeBranchesByThreeWay()
public
mergeBranchesByThreeWay(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—mergeBranchesByThreeWayAsync()
public
mergeBranchesByThreeWayAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—mergePullRequestByFastForward()
public
mergePullRequestByFastForward(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—mergePullRequestByFastForwardAsync()
public
mergePullRequestByFastForwardAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—mergePullRequestBySquash()
public
mergePullRequestBySquash(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—mergePullRequestBySquashAsync()
public
mergePullRequestBySquashAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—mergePullRequestByThreeWay()
public
mergePullRequestByThreeWay(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—mergePullRequestByThreeWayAsync()
public
mergePullRequestByThreeWayAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—overridePullRequestApprovalRules()
public
overridePullRequestApprovalRules(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—overridePullRequestApprovalRulesAsync()
public
overridePullRequestApprovalRulesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—postCommentForComparedCommit()
public
postCommentForComparedCommit(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—postCommentForComparedCommitAsync()
public
postCommentForComparedCommitAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—postCommentForPullRequest()
public
postCommentForPullRequest(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—postCommentForPullRequestAsync()
public
postCommentForPullRequestAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—postCommentReply()
public
postCommentReply(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—postCommentReplyAsync()
public
postCommentReplyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putCommentReaction()
public
putCommentReaction(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putCommentReactionAsync()
public
putCommentReactionAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putFile()
public
putFile(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putFileAsync()
public
putFileAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putRepositoryTriggers()
public
putRepositoryTriggers(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putRepositoryTriggersAsync()
public
putRepositoryTriggersAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—tagResource()
public
tagResource(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—tagResourceAsync()
public
tagResourceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—testRepositoryTriggers()
public
testRepositoryTriggers(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—testRepositoryTriggersAsync()
public
testRepositoryTriggersAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—untagResource()
public
untagResource(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—untagResourceAsync()
public
untagResourceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateApprovalRuleTemplateContent()
public
updateApprovalRuleTemplateContent(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateApprovalRuleTemplateContentAsync()
public
updateApprovalRuleTemplateContentAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateApprovalRuleTemplateDescription()
public
updateApprovalRuleTemplateDescription(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateApprovalRuleTemplateDescriptionAsync()
public
updateApprovalRuleTemplateDescriptionAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateApprovalRuleTemplateName()
public
updateApprovalRuleTemplateName(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateApprovalRuleTemplateNameAsync()
public
updateApprovalRuleTemplateNameAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateComment()
public
updateComment(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateCommentAsync()
public
updateCommentAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateDefaultBranch()
public
updateDefaultBranch(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateDefaultBranchAsync()
public
updateDefaultBranchAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updatePullRequestApprovalRuleContent()
public
updatePullRequestApprovalRuleContent(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updatePullRequestApprovalRuleContentAsync()
public
updatePullRequestApprovalRuleContentAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updatePullRequestApprovalState()
public
updatePullRequestApprovalState(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updatePullRequestApprovalStateAsync()
public
updatePullRequestApprovalStateAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updatePullRequestDescription()
public
updatePullRequestDescription(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updatePullRequestDescriptionAsync()
public
updatePullRequestDescriptionAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updatePullRequestStatus()
public
updatePullRequestStatus(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updatePullRequestStatusAsync()
public
updatePullRequestStatusAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updatePullRequestTitle()
public
updatePullRequestTitle(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updatePullRequestTitleAsync()
public
updatePullRequestTitleAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateRepositoryDescription()
public
updateRepositoryDescription(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateRepositoryDescriptionAsync()
public
updateRepositoryDescriptionAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateRepositoryName()
public
updateRepositoryName(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateRepositoryNameAsync()
public
updateRepositoryNameAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—waitUntil()
public
waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Return values
mixed —addEndpointDiscoveryMiddleware()
private
addEndpointDiscoveryMiddleware(mixed $config, mixed $args) : mixed
Parameters
- $config : mixed
- $args : mixed
Return values
mixed —addEndpointParameterMiddleware()
private
addEndpointParameterMiddleware(mixed $args) : mixed
Parameters
- $args : mixed
Return values
mixed —addInvocationId()
private
addInvocationId() : mixed
Return values
mixed —addSignatureMiddleware()
private
addSignatureMiddleware() : mixed
Return values
mixed —addStreamRequestPayload()
private
addStreamRequestPayload() : mixed
Return values
mixed —loadAliases()
private
loadAliases([mixed $file = null ]) : mixed
Parameters
- $file : mixed = null
Return values
mixed —parseClass()
Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".
private
parseClass() : array<string|int, mixed>