SDK for PHP V3

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.

Tags
phpstan-method

\Aws\Result associateApprovalRuleTemplateWithRepository(array{approvalRuleTemplateName?: string, repositoryName?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise associateApprovalRuleTemplateWithRepositoryAsync(array{approvalRuleTemplateName?: string, repositoryName?: string, ...} $args = [])

phpstan-method

\Aws\Result batchAssociateApprovalRuleTemplateWithRepositories(array{approvalRuleTemplateName?: string, repositoryNames?: list, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise batchAssociateApprovalRuleTemplateWithRepositoriesAsync(array{approvalRuleTemplateName?: string, repositoryNames?: list, ...} $args = [])

phpstan-method

\Aws\Result batchDescribeMergeConflicts(array{ repositoryName?: string, destinationCommitSpecifier?: string, sourceCommitSpecifier?: string, mergeOption?: 'FAST_FORWARD_MERGE'|'SQUASH_MERGE'|'THREE_WAY_MERGE', maxMergeHunks?: int, maxConflictFiles?: int, filePaths?: list, conflictDetailLevel?: 'FILE_LEVEL'|'LINE_LEVEL', conflictResolutionStrategy?: 'ACCEPT_DESTINATION'|'ACCEPT_SOURCE'|'AUTOMERGE'|'NONE', nextToken?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise batchDescribeMergeConflictsAsync(array{ repositoryName?: string, destinationCommitSpecifier?: string, sourceCommitSpecifier?: string, mergeOption?: 'FAST_FORWARD_MERGE'|'SQUASH_MERGE'|'THREE_WAY_MERGE', maxMergeHunks?: int, maxConflictFiles?: int, filePaths?: list, conflictDetailLevel?: 'FILE_LEVEL'|'LINE_LEVEL', conflictResolutionStrategy?: 'ACCEPT_DESTINATION'|'ACCEPT_SOURCE'|'AUTOMERGE'|'NONE', nextToken?: string, ..., } $args = [])

phpstan-method

\Aws\Result batchDisassociateApprovalRuleTemplateFromRepositories(array{approvalRuleTemplateName?: string, repositoryNames?: list, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise batchDisassociateApprovalRuleTemplateFromRepositoriesAsync(array{approvalRuleTemplateName?: string, repositoryNames?: list, ...} $args = [])

phpstan-method

\Aws\Result batchGetCommits(array{commitIds?: list, repositoryName?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise batchGetCommitsAsync(array{commitIds?: list, repositoryName?: string, ...} $args = [])

phpstan-method

\Aws\Result batchGetRepositories(array{repositoryNames?: list, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise batchGetRepositoriesAsync(array{repositoryNames?: list, ...} $args = [])

phpstan-method

\Aws\Result createApprovalRuleTemplate(array{ approvalRuleTemplateName?: string, approvalRuleTemplateContent?: string, approvalRuleTemplateDescription?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createApprovalRuleTemplateAsync(array{ approvalRuleTemplateName?: string, approvalRuleTemplateContent?: string, approvalRuleTemplateDescription?: string, ..., } $args = [])

phpstan-method

\Aws\Result createBranch(array{repositoryName?: string, branchName?: string, commitId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createBranchAsync(array{repositoryName?: string, branchName?: string, commitId?: string, ...} $args = [])

phpstan-method

\Aws\Result createCommit(array{ repositoryName?: string, branchName?: string, parentCommitId?: string, authorName?: string, email?: string, commitMessage?: string, keepEmptyFolders?: bool, putFiles?: list<array{ filePath?: string, fileMode?: 'EXECUTABLE'|'NORMAL'|'SYMLINK', fileContent?: string|resource|\Psr\Http\Message\StreamInterface, sourceFile?: array, ..., }>, deleteFiles?: list<array{filePath?: string, ...}>, setFileModes?: list<array{filePath?: string, fileMode?: 'EXECUTABLE'|'NORMAL'|'SYMLINK', ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createCommitAsync(array{ repositoryName?: string, branchName?: string, parentCommitId?: string, authorName?: string, email?: string, commitMessage?: string, keepEmptyFolders?: bool, putFiles?: list<array{ filePath?: string, fileMode?: 'EXECUTABLE'|'NORMAL'|'SYMLINK', fileContent?: string|resource|\Psr\Http\Message\StreamInterface, sourceFile?: array, ..., }>, deleteFiles?: list<array{filePath?: string, ...}>, setFileModes?: list<array{filePath?: string, fileMode?: 'EXECUTABLE'|'NORMAL'|'SYMLINK', ...}>, ..., } $args = [])

phpstan-method

\Aws\Result createPullRequest(array{ title?: string, description?: string, targets?: list<array{repositoryName?: string, sourceReference?: string, destinationReference?: string, ...}>, clientRequestToken?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createPullRequestAsync(array{ title?: string, description?: string, targets?: list<array{repositoryName?: string, sourceReference?: string, destinationReference?: string, ...}>, clientRequestToken?: string, ..., } $args = [])

phpstan-method

\Aws\Result createPullRequestApprovalRule(array{pullRequestId?: string, approvalRuleName?: string, approvalRuleContent?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createPullRequestApprovalRuleAsync(array{pullRequestId?: string, approvalRuleName?: string, approvalRuleContent?: string, ...} $args = [])

phpstan-method

\Aws\Result createRepository(array{ repositoryName?: string, repositoryDescription?: string, tags?: array<string, string>, kmsKeyId?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createRepositoryAsync(array{ repositoryName?: string, repositoryDescription?: string, tags?: array<string, string>, kmsKeyId?: string, ..., } $args = [])

phpstan-method

\Aws\Result createUnreferencedMergeCommit(array{ repositoryName?: string, sourceCommitSpecifier?: string, destinationCommitSpecifier?: string, mergeOption?: 'FAST_FORWARD_MERGE'|'SQUASH_MERGE'|'THREE_WAY_MERGE', conflictDetailLevel?: 'FILE_LEVEL'|'LINE_LEVEL', conflictResolutionStrategy?: 'ACCEPT_DESTINATION'|'ACCEPT_SOURCE'|'AUTOMERGE'|'NONE', authorName?: string, email?: string, commitMessage?: string, keepEmptyFolders?: bool, conflictResolution?: array{replaceContents?: list, deleteFiles?: list, setFileModes?: list, ...}, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createUnreferencedMergeCommitAsync(array{ repositoryName?: string, sourceCommitSpecifier?: string, destinationCommitSpecifier?: string, mergeOption?: 'FAST_FORWARD_MERGE'|'SQUASH_MERGE'|'THREE_WAY_MERGE', conflictDetailLevel?: 'FILE_LEVEL'|'LINE_LEVEL', conflictResolutionStrategy?: 'ACCEPT_DESTINATION'|'ACCEPT_SOURCE'|'AUTOMERGE'|'NONE', authorName?: string, email?: string, commitMessage?: string, keepEmptyFolders?: bool, conflictResolution?: array{replaceContents?: list, deleteFiles?: list, setFileModes?: list, ...}, ..., } $args = [])

phpstan-method

\Aws\Result deleteApprovalRuleTemplate(array{approvalRuleTemplateName?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteApprovalRuleTemplateAsync(array{approvalRuleTemplateName?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteBranch(array{repositoryName?: string, branchName?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteBranchAsync(array{repositoryName?: string, branchName?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteCommentContent(array{commentId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteCommentContentAsync(array{commentId?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteFile(array{ repositoryName?: string, branchName?: string, filePath?: string, parentCommitId?: string, keepEmptyFolders?: bool, commitMessage?: string, name?: string, email?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteFileAsync(array{ repositoryName?: string, branchName?: string, filePath?: string, parentCommitId?: string, keepEmptyFolders?: bool, commitMessage?: string, name?: string, email?: string, ..., } $args = [])

phpstan-method

\Aws\Result deletePullRequestApprovalRule(array{pullRequestId?: string, approvalRuleName?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deletePullRequestApprovalRuleAsync(array{pullRequestId?: string, approvalRuleName?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteRepository(array{repositoryName?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteRepositoryAsync(array{repositoryName?: string, ...} $args = [])

phpstan-method

\Aws\Result describeMergeConflicts(array{ repositoryName?: string, destinationCommitSpecifier?: string, sourceCommitSpecifier?: string, mergeOption?: 'FAST_FORWARD_MERGE'|'SQUASH_MERGE'|'THREE_WAY_MERGE', maxMergeHunks?: int, filePath?: string, conflictDetailLevel?: 'FILE_LEVEL'|'LINE_LEVEL', conflictResolutionStrategy?: 'ACCEPT_DESTINATION'|'ACCEPT_SOURCE'|'AUTOMERGE'|'NONE', nextToken?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise describeMergeConflictsAsync(array{ repositoryName?: string, destinationCommitSpecifier?: string, sourceCommitSpecifier?: string, mergeOption?: 'FAST_FORWARD_MERGE'|'SQUASH_MERGE'|'THREE_WAY_MERGE', maxMergeHunks?: int, filePath?: string, conflictDetailLevel?: 'FILE_LEVEL'|'LINE_LEVEL', conflictResolutionStrategy?: 'ACCEPT_DESTINATION'|'ACCEPT_SOURCE'|'AUTOMERGE'|'NONE', nextToken?: string, ..., } $args = [])

phpstan-method

\Aws\Result describePullRequestEvents(array{ pullRequestId?: string, pullRequestEventType?: 'PULL_REQUEST_APPROVAL_RULE_CREATED'|'PULL_REQUEST_APPROVAL_RULE_DELETED'|'PULL_REQUEST_APPROVAL_RULE_OVERRIDDEN'|'PULL_REQUEST_APPROVAL_RULE_UPDATED'|'PULL_REQUEST_APPROVAL_STATE_CHANGED'|'PULL_REQUEST_CREATED'|'PULL_REQUEST_MERGE_STATE_CHANGED'|'PULL_REQUEST_SOURCE_REFERENCE_UPDATED'|'PULL_REQUEST_STATUS_CHANGED', actorArn?: string, nextToken?: string, maxResults?: int, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise describePullRequestEventsAsync(array{ pullRequestId?: string, pullRequestEventType?: 'PULL_REQUEST_APPROVAL_RULE_CREATED'|'PULL_REQUEST_APPROVAL_RULE_DELETED'|'PULL_REQUEST_APPROVAL_RULE_OVERRIDDEN'|'PULL_REQUEST_APPROVAL_RULE_UPDATED'|'PULL_REQUEST_APPROVAL_STATE_CHANGED'|'PULL_REQUEST_CREATED'|'PULL_REQUEST_MERGE_STATE_CHANGED'|'PULL_REQUEST_SOURCE_REFERENCE_UPDATED'|'PULL_REQUEST_STATUS_CHANGED', actorArn?: string, nextToken?: string, maxResults?: int, ..., } $args = [])

phpstan-method

\Aws\Result disassociateApprovalRuleTemplateFromRepository(array{approvalRuleTemplateName?: string, repositoryName?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise disassociateApprovalRuleTemplateFromRepositoryAsync(array{approvalRuleTemplateName?: string, repositoryName?: string, ...} $args = [])

phpstan-method

\Aws\Result evaluatePullRequestApprovalRules(array{pullRequestId?: string, revisionId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise evaluatePullRequestApprovalRulesAsync(array{pullRequestId?: string, revisionId?: string, ...} $args = [])

phpstan-method

\Aws\Result getApprovalRuleTemplate(array{approvalRuleTemplateName?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getApprovalRuleTemplateAsync(array{approvalRuleTemplateName?: string, ...} $args = [])

phpstan-method

\Aws\Result getBlob(array{repositoryName?: string, blobId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getBlobAsync(array{repositoryName?: string, blobId?: string, ...} $args = [])

phpstan-method

\Aws\Result getBlobDifferences(array{ repositoryName?: string, afterBlobId?: string, beforeBlobId?: string, contextLines?: int, ignoreWhitespace?: bool, MaxResults?: int, NextToken?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getBlobDifferencesAsync(array{ repositoryName?: string, afterBlobId?: string, beforeBlobId?: string, contextLines?: int, ignoreWhitespace?: bool, MaxResults?: int, NextToken?: string, ..., } $args = [])

phpstan-method

\Aws\Result getBranch(array{repositoryName?: string, branchName?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getBranchAsync(array{repositoryName?: string, branchName?: string, ...} $args = [])

phpstan-method

\Aws\Result getComment(array{commentId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getCommentAsync(array{commentId?: string, ...} $args = [])

phpstan-method

\Aws\Result getCommentReactions(array{commentId?: string, reactionUserArn?: string, nextToken?: string, maxResults?: int, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getCommentReactionsAsync(array{commentId?: string, reactionUserArn?: string, nextToken?: string, maxResults?: int, ...} $args = [])

phpstan-method

\Aws\Result getCommentsForComparedCommit(array{ repositoryName?: string, beforeCommitId?: string, afterCommitId?: string, nextToken?: string, maxResults?: int, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getCommentsForComparedCommitAsync(array{ repositoryName?: string, beforeCommitId?: string, afterCommitId?: string, nextToken?: string, maxResults?: int, ..., } $args = [])

phpstan-method

\Aws\Result getCommentsForPullRequest(array{ pullRequestId?: string, repositoryName?: string, beforeCommitId?: string, afterCommitId?: string, nextToken?: string, maxResults?: int, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getCommentsForPullRequestAsync(array{ pullRequestId?: string, repositoryName?: string, beforeCommitId?: string, afterCommitId?: string, nextToken?: string, maxResults?: int, ..., } $args = [])

phpstan-method

\Aws\Result getCommit(array{repositoryName?: string, commitId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getCommitAsync(array{repositoryName?: string, commitId?: string, ...} $args = [])

phpstan-method

\Aws\Result getDifferences(array{ repositoryName?: string, beforeCommitSpecifier?: string, afterCommitSpecifier?: string, beforePath?: string, afterPath?: string, MaxResults?: int, NextToken?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getDifferencesAsync(array{ repositoryName?: string, beforeCommitSpecifier?: string, afterCommitSpecifier?: string, beforePath?: string, afterPath?: string, MaxResults?: int, NextToken?: string, ..., } $args = [])

phpstan-method

\Aws\Result getFile(array{repositoryName?: string, commitSpecifier?: string, filePath?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getFileAsync(array{repositoryName?: string, commitSpecifier?: string, filePath?: string, ...} $args = [])

phpstan-method

\Aws\Result getFolder(array{repositoryName?: string, commitSpecifier?: string, folderPath?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getFolderAsync(array{repositoryName?: string, commitSpecifier?: string, folderPath?: string, ...} $args = [])

phpstan-method

\Aws\Result getMergeCommit(array{ repositoryName?: string, sourceCommitSpecifier?: string, destinationCommitSpecifier?: string, conflictDetailLevel?: 'FILE_LEVEL'|'LINE_LEVEL', conflictResolutionStrategy?: 'ACCEPT_DESTINATION'|'ACCEPT_SOURCE'|'AUTOMERGE'|'NONE', ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getMergeCommitAsync(array{ repositoryName?: string, sourceCommitSpecifier?: string, destinationCommitSpecifier?: string, conflictDetailLevel?: 'FILE_LEVEL'|'LINE_LEVEL', conflictResolutionStrategy?: 'ACCEPT_DESTINATION'|'ACCEPT_SOURCE'|'AUTOMERGE'|'NONE', ..., } $args = [])

phpstan-method

\Aws\Result getMergeConflicts(array{ repositoryName?: string, destinationCommitSpecifier?: string, sourceCommitSpecifier?: string, mergeOption?: 'FAST_FORWARD_MERGE'|'SQUASH_MERGE'|'THREE_WAY_MERGE', conflictDetailLevel?: 'FILE_LEVEL'|'LINE_LEVEL', maxConflictFiles?: int, conflictResolutionStrategy?: 'ACCEPT_DESTINATION'|'ACCEPT_SOURCE'|'AUTOMERGE'|'NONE', nextToken?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getMergeConflictsAsync(array{ repositoryName?: string, destinationCommitSpecifier?: string, sourceCommitSpecifier?: string, mergeOption?: 'FAST_FORWARD_MERGE'|'SQUASH_MERGE'|'THREE_WAY_MERGE', conflictDetailLevel?: 'FILE_LEVEL'|'LINE_LEVEL', maxConflictFiles?: int, conflictResolutionStrategy?: 'ACCEPT_DESTINATION'|'ACCEPT_SOURCE'|'AUTOMERGE'|'NONE', nextToken?: string, ..., } $args = [])

phpstan-method

\Aws\Result getMergeOptions(array{ repositoryName?: string, sourceCommitSpecifier?: string, destinationCommitSpecifier?: string, conflictDetailLevel?: 'FILE_LEVEL'|'LINE_LEVEL', conflictResolutionStrategy?: 'ACCEPT_DESTINATION'|'ACCEPT_SOURCE'|'AUTOMERGE'|'NONE', ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getMergeOptionsAsync(array{ repositoryName?: string, sourceCommitSpecifier?: string, destinationCommitSpecifier?: string, conflictDetailLevel?: 'FILE_LEVEL'|'LINE_LEVEL', conflictResolutionStrategy?: 'ACCEPT_DESTINATION'|'ACCEPT_SOURCE'|'AUTOMERGE'|'NONE', ..., } $args = [])

phpstan-method

\Aws\Result getPullRequest(array{pullRequestId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getPullRequestAsync(array{pullRequestId?: string, ...} $args = [])

phpstan-method

\Aws\Result getPullRequestApprovalStates(array{pullRequestId?: string, revisionId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getPullRequestApprovalStatesAsync(array{pullRequestId?: string, revisionId?: string, ...} $args = [])

phpstan-method

\Aws\Result getPullRequestOverrideState(array{pullRequestId?: string, revisionId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getPullRequestOverrideStateAsync(array{pullRequestId?: string, revisionId?: string, ...} $args = [])

phpstan-method

\Aws\Result getRepository(array{repositoryName?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getRepositoryAsync(array{repositoryName?: string, ...} $args = [])

phpstan-method

\Aws\Result getRepositoryTriggers(array{repositoryName?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getRepositoryTriggersAsync(array{repositoryName?: string, ...} $args = [])

phpstan-method

\Aws\Result listApprovalRuleTemplates(array{nextToken?: string, maxResults?: int, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise listApprovalRuleTemplatesAsync(array{nextToken?: string, maxResults?: int, ...} $args = [])

phpstan-method

\Aws\Result listAssociatedApprovalRuleTemplatesForRepository(array{repositoryName?: string, nextToken?: string, maxResults?: int, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise listAssociatedApprovalRuleTemplatesForRepositoryAsync(array{repositoryName?: string, nextToken?: string, maxResults?: int, ...} $args = [])

phpstan-method

\Aws\Result listBranches(array{repositoryName?: string, nextToken?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise listBranchesAsync(array{repositoryName?: string, nextToken?: string, ...} $args = [])

phpstan-method

\Aws\Result listFileCommitHistory(array{ repositoryName?: string, commitSpecifier?: string, filePath?: string, maxResults?: int, nextToken?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise listFileCommitHistoryAsync(array{ repositoryName?: string, commitSpecifier?: string, filePath?: string, maxResults?: int, nextToken?: string, ..., } $args = [])

phpstan-method

\Aws\Result listPullRequests(array{ repositoryName?: string, authorArn?: string, pullRequestStatus?: 'CLOSED'|'OPEN', nextToken?: string, maxResults?: int, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise listPullRequestsAsync(array{ repositoryName?: string, authorArn?: string, pullRequestStatus?: 'CLOSED'|'OPEN', nextToken?: string, maxResults?: int, ..., } $args = [])

phpstan-method

\Aws\Result listRepositories(array{nextToken?: string, sortBy?: 'lastModifiedDate'|'repositoryName', order?: 'ascending'|'descending', ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise listRepositoriesAsync(array{nextToken?: string, sortBy?: 'lastModifiedDate'|'repositoryName', order?: 'ascending'|'descending', ...} $args = [])

phpstan-method

\Aws\Result listRepositoriesForApprovalRuleTemplate(array{approvalRuleTemplateName?: string, nextToken?: string, maxResults?: int, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise listRepositoriesForApprovalRuleTemplateAsync(array{approvalRuleTemplateName?: string, nextToken?: string, maxResults?: int, ...} $args = [])

phpstan-method

\Aws\Result listTagsForResource(array{resourceArn?: string, nextToken?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise listTagsForResourceAsync(array{resourceArn?: string, nextToken?: string, ...} $args = [])

phpstan-method

\Aws\Result mergeBranchesByFastForward(array{ repositoryName?: string, sourceCommitSpecifier?: string, destinationCommitSpecifier?: string, targetBranch?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise mergeBranchesByFastForwardAsync(array{ repositoryName?: string, sourceCommitSpecifier?: string, destinationCommitSpecifier?: string, targetBranch?: string, ..., } $args = [])

phpstan-method

\Aws\Result mergeBranchesBySquash(array{ repositoryName?: string, sourceCommitSpecifier?: string, destinationCommitSpecifier?: string, targetBranch?: string, conflictDetailLevel?: 'FILE_LEVEL'|'LINE_LEVEL', conflictResolutionStrategy?: 'ACCEPT_DESTINATION'|'ACCEPT_SOURCE'|'AUTOMERGE'|'NONE', authorName?: string, email?: string, commitMessage?: string, keepEmptyFolders?: bool, conflictResolution?: array{replaceContents?: list, deleteFiles?: list, setFileModes?: list, ...}, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise mergeBranchesBySquashAsync(array{ repositoryName?: string, sourceCommitSpecifier?: string, destinationCommitSpecifier?: string, targetBranch?: string, conflictDetailLevel?: 'FILE_LEVEL'|'LINE_LEVEL', conflictResolutionStrategy?: 'ACCEPT_DESTINATION'|'ACCEPT_SOURCE'|'AUTOMERGE'|'NONE', authorName?: string, email?: string, commitMessage?: string, keepEmptyFolders?: bool, conflictResolution?: array{replaceContents?: list, deleteFiles?: list, setFileModes?: list, ...}, ..., } $args = [])

phpstan-method

\Aws\Result mergeBranchesByThreeWay(array{ repositoryName?: string, sourceCommitSpecifier?: string, destinationCommitSpecifier?: string, targetBranch?: string, conflictDetailLevel?: 'FILE_LEVEL'|'LINE_LEVEL', conflictResolutionStrategy?: 'ACCEPT_DESTINATION'|'ACCEPT_SOURCE'|'AUTOMERGE'|'NONE', authorName?: string, email?: string, commitMessage?: string, keepEmptyFolders?: bool, conflictResolution?: array{replaceContents?: list, deleteFiles?: list, setFileModes?: list, ...}, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise mergeBranchesByThreeWayAsync(array{ repositoryName?: string, sourceCommitSpecifier?: string, destinationCommitSpecifier?: string, targetBranch?: string, conflictDetailLevel?: 'FILE_LEVEL'|'LINE_LEVEL', conflictResolutionStrategy?: 'ACCEPT_DESTINATION'|'ACCEPT_SOURCE'|'AUTOMERGE'|'NONE', authorName?: string, email?: string, commitMessage?: string, keepEmptyFolders?: bool, conflictResolution?: array{replaceContents?: list, deleteFiles?: list, setFileModes?: list, ...}, ..., } $args = [])

phpstan-method

\Aws\Result mergePullRequestByFastForward(array{pullRequestId?: string, repositoryName?: string, sourceCommitId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise mergePullRequestByFastForwardAsync(array{pullRequestId?: string, repositoryName?: string, sourceCommitId?: string, ...} $args = [])

phpstan-method

\Aws\Result mergePullRequestBySquash(array{ pullRequestId?: string, repositoryName?: string, sourceCommitId?: string, conflictDetailLevel?: 'FILE_LEVEL'|'LINE_LEVEL', conflictResolutionStrategy?: 'ACCEPT_DESTINATION'|'ACCEPT_SOURCE'|'AUTOMERGE'|'NONE', commitMessage?: string, authorName?: string, email?: string, keepEmptyFolders?: bool, conflictResolution?: array{replaceContents?: list, deleteFiles?: list, setFileModes?: list, ...}, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise mergePullRequestBySquashAsync(array{ pullRequestId?: string, repositoryName?: string, sourceCommitId?: string, conflictDetailLevel?: 'FILE_LEVEL'|'LINE_LEVEL', conflictResolutionStrategy?: 'ACCEPT_DESTINATION'|'ACCEPT_SOURCE'|'AUTOMERGE'|'NONE', commitMessage?: string, authorName?: string, email?: string, keepEmptyFolders?: bool, conflictResolution?: array{replaceContents?: list, deleteFiles?: list, setFileModes?: list, ...}, ..., } $args = [])

phpstan-method

\Aws\Result mergePullRequestByThreeWay(array{ pullRequestId?: string, repositoryName?: string, sourceCommitId?: string, conflictDetailLevel?: 'FILE_LEVEL'|'LINE_LEVEL', conflictResolutionStrategy?: 'ACCEPT_DESTINATION'|'ACCEPT_SOURCE'|'AUTOMERGE'|'NONE', commitMessage?: string, authorName?: string, email?: string, keepEmptyFolders?: bool, conflictResolution?: array{replaceContents?: list, deleteFiles?: list, setFileModes?: list, ...}, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise mergePullRequestByThreeWayAsync(array{ pullRequestId?: string, repositoryName?: string, sourceCommitId?: string, conflictDetailLevel?: 'FILE_LEVEL'|'LINE_LEVEL', conflictResolutionStrategy?: 'ACCEPT_DESTINATION'|'ACCEPT_SOURCE'|'AUTOMERGE'|'NONE', commitMessage?: string, authorName?: string, email?: string, keepEmptyFolders?: bool, conflictResolution?: array{replaceContents?: list, deleteFiles?: list, setFileModes?: list, ...}, ..., } $args = [])

phpstan-method

\Aws\Result overridePullRequestApprovalRules(array{pullRequestId?: string, revisionId?: string, overrideStatus?: 'OVERRIDE'|'REVOKE', ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise overridePullRequestApprovalRulesAsync(array{pullRequestId?: string, revisionId?: string, overrideStatus?: 'OVERRIDE'|'REVOKE', ...} $args = [])

phpstan-method

\Aws\Result postCommentForComparedCommit(array{ repositoryName?: string, beforeCommitId?: string, afterCommitId?: string, location?: array{filePath?: string, filePosition?: int, relativeFileVersion?: 'AFTER'|'BEFORE', ...}, content?: string, clientRequestToken?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise postCommentForComparedCommitAsync(array{ repositoryName?: string, beforeCommitId?: string, afterCommitId?: string, location?: array{filePath?: string, filePosition?: int, relativeFileVersion?: 'AFTER'|'BEFORE', ...}, content?: string, clientRequestToken?: string, ..., } $args = [])

phpstan-method

\Aws\Result postCommentForPullRequest(array{ pullRequestId?: string, repositoryName?: string, beforeCommitId?: string, afterCommitId?: string, location?: array{filePath?: string, filePosition?: int, relativeFileVersion?: 'AFTER'|'BEFORE', ...}, content?: string, clientRequestToken?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise postCommentForPullRequestAsync(array{ pullRequestId?: string, repositoryName?: string, beforeCommitId?: string, afterCommitId?: string, location?: array{filePath?: string, filePosition?: int, relativeFileVersion?: 'AFTER'|'BEFORE', ...}, content?: string, clientRequestToken?: string, ..., } $args = [])

phpstan-method

\Aws\Result postCommentReply(array{inReplyTo?: string, clientRequestToken?: string, content?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise postCommentReplyAsync(array{inReplyTo?: string, clientRequestToken?: string, content?: string, ...} $args = [])

phpstan-method

\Aws\Result putCommentReaction(array{commentId?: string, reactionValue?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putCommentReactionAsync(array{commentId?: string, reactionValue?: string, ...} $args = [])

phpstan-method

\Aws\Result putFile(array{ repositoryName?: string, branchName?: string, fileContent?: string|resource|\Psr\Http\Message\StreamInterface, filePath?: string, fileMode?: 'EXECUTABLE'|'NORMAL'|'SYMLINK', parentCommitId?: string, commitMessage?: string, name?: string, email?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putFileAsync(array{ repositoryName?: string, branchName?: string, fileContent?: string|resource|\Psr\Http\Message\StreamInterface, filePath?: string, fileMode?: 'EXECUTABLE'|'NORMAL'|'SYMLINK', parentCommitId?: string, commitMessage?: string, name?: string, email?: string, ..., } $args = [])

phpstan-method

\Aws\Result putRepositoryTriggers(array{ repositoryName?: string, triggers?: list<array{ name?: string, destinationArn?: string, customData?: string, branches?: list, events?: list<'all'|'createReference'|'deleteReference'|'updateReference'>, ..., }>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putRepositoryTriggersAsync(array{ repositoryName?: string, triggers?: list<array{ name?: string, destinationArn?: string, customData?: string, branches?: list, events?: list<'all'|'createReference'|'deleteReference'|'updateReference'>, ..., }>, ..., } $args = [])

phpstan-method

\Aws\Result tagResource(array{resourceArn?: string, tags?: array<string, string>, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise tagResourceAsync(array{resourceArn?: string, tags?: array<string, string>, ...} $args = [])

phpstan-method

\Aws\Result testRepositoryTriggers(array{ repositoryName?: string, triggers?: list<array{ name?: string, destinationArn?: string, customData?: string, branches?: list, events?: list<'all'|'createReference'|'deleteReference'|'updateReference'>, ..., }>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise testRepositoryTriggersAsync(array{ repositoryName?: string, triggers?: list<array{ name?: string, destinationArn?: string, customData?: string, branches?: list, events?: list<'all'|'createReference'|'deleteReference'|'updateReference'>, ..., }>, ..., } $args = [])

phpstan-method

\Aws\Result untagResource(array{resourceArn?: string, tagKeys?: list, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise untagResourceAsync(array{resourceArn?: string, tagKeys?: list, ...} $args = [])

phpstan-method

\Aws\Result updateApprovalRuleTemplateContent(array{approvalRuleTemplateName?: string, newRuleContent?: string, existingRuleContentSha256?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateApprovalRuleTemplateContentAsync(array{approvalRuleTemplateName?: string, newRuleContent?: string, existingRuleContentSha256?: string, ...} $args = [])

phpstan-method

\Aws\Result updateApprovalRuleTemplateDescription(array{approvalRuleTemplateName?: string, approvalRuleTemplateDescription?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateApprovalRuleTemplateDescriptionAsync(array{approvalRuleTemplateName?: string, approvalRuleTemplateDescription?: string, ...} $args = [])

phpstan-method

\Aws\Result updateApprovalRuleTemplateName(array{oldApprovalRuleTemplateName?: string, newApprovalRuleTemplateName?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateApprovalRuleTemplateNameAsync(array{oldApprovalRuleTemplateName?: string, newApprovalRuleTemplateName?: string, ...} $args = [])

phpstan-method

\Aws\Result updateComment(array{commentId?: string, content?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateCommentAsync(array{commentId?: string, content?: string, ...} $args = [])

phpstan-method

\Aws\Result updateDefaultBranch(array{repositoryName?: string, defaultBranchName?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateDefaultBranchAsync(array{repositoryName?: string, defaultBranchName?: string, ...} $args = [])

phpstan-method

\Aws\Result updatePullRequestApprovalRuleContent(array{ pullRequestId?: string, approvalRuleName?: string, existingRuleContentSha256?: string, newRuleContent?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updatePullRequestApprovalRuleContentAsync(array{ pullRequestId?: string, approvalRuleName?: string, existingRuleContentSha256?: string, newRuleContent?: string, ..., } $args = [])

phpstan-method

\Aws\Result updatePullRequestApprovalState(array{pullRequestId?: string, revisionId?: string, approvalState?: 'APPROVE'|'REVOKE', ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updatePullRequestApprovalStateAsync(array{pullRequestId?: string, revisionId?: string, approvalState?: 'APPROVE'|'REVOKE', ...} $args = [])

phpstan-method

\Aws\Result updatePullRequestDescription(array{pullRequestId?: string, description?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updatePullRequestDescriptionAsync(array{pullRequestId?: string, description?: string, ...} $args = [])

phpstan-method

\Aws\Result updatePullRequestStatus(array{pullRequestId?: string, pullRequestStatus?: 'CLOSED'|'OPEN', ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updatePullRequestStatusAsync(array{pullRequestId?: string, pullRequestStatus?: 'CLOSED'|'OPEN', ...} $args = [])

phpstan-method

\Aws\Result updatePullRequestTitle(array{pullRequestId?: string, title?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updatePullRequestTitleAsync(array{pullRequestId?: string, title?: string, ...} $args = [])

phpstan-method

\Aws\Result updateRepositoryDescription(array{repositoryName?: string, repositoryDescription?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateRepositoryDescriptionAsync(array{repositoryName?: string, repositoryDescription?: string, ...} $args = [])

phpstan-method

\Aws\Result updateRepositoryEncryptionKey(array{repositoryName?: string, kmsKeyId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateRepositoryEncryptionKeyAsync(array{repositoryName?: string, kmsKeyId?: string, ...} $args = [])

phpstan-method

\Aws\Result updateRepositoryName(array{oldName?: string, newName?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateRepositoryNameAsync(array{oldName?: string, newName?: string, ...} $args = [])

Table of Contents

Methods

__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
execute()  : mixed
executeAsync()  : mixed
factory()  : static
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
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
getConfig()  : mixed|null
Get a client configuration value.
getCredentials()  : PromiseInterface
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
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.
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getIterator()  : mixed
getPaginator()  : mixed
getRegion()  : string
Get the region to which the client is configured to send requests.
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getToken()  : mixed
getWaiter()  : mixed
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.
  • transport_sharing: (string) Set to a transport sharing mode ("none", "handler_prefer", "handler_require", "persistent_prefer", or "persistent_require") to enable connection sharing on the default HTTP handler. The "_prefer" modes degrade gracefully when the installed version of Guzzle or the runtime cannot honor them, and the "_require" modes throw. This option only applies when the SDK creates the default HTTP handler.
  • 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).
  • account_id_endpoint_mode: (string, default(preferred)) this option decides whether credentials should resolve an accountId value, which is going to be used as part of the endpoint resolution. The valid values for this option are:
    • preferred: when this value is set then, a warning is logged when accountId is empty in the resolved identity.
    • required: when this value is set then, an exception is thrown when accountId is empty in the resolved identity.
    • disabled: when this value is set then, the validation for if accountId was resolved or not, is ignored.
  • 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

factory()

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

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>

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

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

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>

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> = []

getPaginator()

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

getRegion()

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

public getRegion() : string
Return values
string

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable

getToken()

public getToken() : mixed

getWaiter()

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

waitUntil()

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