AthenaClient
extends AwsClient
in package
This client is used to interact with the Amazon Athena 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.
- BatchGetNamedQuery
- BatchGetPreparedStatement
- BatchGetQueryExecution
- CancelCapacityReservation
- CreateCapacityReservation
- CreateDataCatalog
- CreateNamedQuery
- CreateNotebook
- CreatePreparedStatement
- CreatePresignedNotebookUrl
- CreateWorkGroup
- DeleteCapacityReservation
- DeleteDataCatalog
- DeleteNamedQuery
- DeleteNotebook
- DeletePreparedStatement
- DeleteWorkGroup
- ExportNotebook
- GetCalculationExecution
- GetCalculationExecutionCode
- GetCalculationExecutionStatus
- GetCapacityAssignmentConfiguration
- GetCapacityReservation
- GetDataCatalog
- GetDatabase
- GetNamedQuery
- GetNotebookMetadata
- GetPreparedStatement
- GetQueryExecution
- GetQueryResults
- GetQueryRuntimeStatistics
- GetSession
- GetSessionStatus
- GetTableMetadata
- GetWorkGroup
- ImportNotebook
- ListApplicationDPUSizes
- ListCalculationExecutions
- ListCapacityReservations
- ListDataCatalogs
- ListDatabases
- ListEngineVersions
- ListExecutors
- ListNamedQueries
- ListNotebookMetadata
- ListNotebookSessions
- ListPreparedStatements
- ListQueryExecutions
- ListSessions
- ListTableMetadata
- ListTagsForResource
- ListWorkGroups
- PutCapacityAssignmentConfiguration
- StartCalculationExecution
- StartQueryExecution
- StartSession
- StopCalculationExecution
- StopQueryExecution
- TagResource
- TerminateSession
- UntagResource
- UpdateCapacityReservation
- UpdateDataCatalog
- UpdateNamedQuery
- UpdateNotebook
- UpdateNotebookMetadata
- UpdatePreparedStatement
- UpdateWorkGroup
Table of Contents
Methods
- __call() : mixed
- __construct() : mixed
- The client constructor accepts the following options:
- __sleep() : mixed
- batchGetNamedQuery() : Result
- batchGetNamedQueryAsync() : Promise
- batchGetPreparedStatement() : Result
- batchGetPreparedStatementAsync() : Promise
- batchGetQueryExecution() : Result
- batchGetQueryExecutionAsync() : Promise
- cancelCapacityReservation() : Result
- cancelCapacityReservationAsync() : Promise
- createCapacityReservation() : Result
- createCapacityReservationAsync() : Promise
- createDataCatalog() : Result
- createDataCatalogAsync() : Promise
- createNamedQuery() : Result
- createNamedQueryAsync() : Promise
- createNotebook() : Result
- createNotebookAsync() : Promise
- createPreparedStatement() : Result
- createPreparedStatementAsync() : Promise
- createPresignedNotebookUrl() : Result
- createPresignedNotebookUrlAsync() : Promise
- createWorkGroup() : Result
- createWorkGroupAsync() : Promise
- deleteCapacityReservation() : Result
- deleteCapacityReservationAsync() : Promise
- deleteDataCatalog() : Result
- deleteDataCatalogAsync() : Promise
- deleteNamedQuery() : Result
- deleteNamedQueryAsync() : Promise
- deleteNotebook() : Result
- deleteNotebookAsync() : Promise
- deletePreparedStatement() : Result
- deletePreparedStatementAsync() : Promise
- deleteWorkGroup() : Result
- deleteWorkGroupAsync() : Promise
- emitDeprecationWarning() : mixed
- execute() : mixed
- executeAsync() : mixed
- exportNotebook() : Result
- exportNotebookAsync() : Promise
- factory() : static
- getApi() : Service
- getArguments() : array<string|int, mixed>
- Get an array of client constructor arguments used by the client.
- getCalculationExecution() : Result
- getCalculationExecutionAsync() : Promise
- getCalculationExecutionCode() : Result
- getCalculationExecutionCodeAsync() : Promise
- getCalculationExecutionStatus() : Result
- getCalculationExecutionStatusAsync() : Promise
- getCapacityAssignmentConfiguration() : Result
- getCapacityAssignmentConfigurationAsync() : Promise
- getCapacityReservation() : Result
- getCapacityReservationAsync() : Promise
- getClientBuiltIns() : array<string|int, mixed>
- Provides the set of built-in keys and values used for endpoint resolution
- getClientContextParams() : array<string|int, mixed>
- Provides the set of service context parameter key-value pairs used for endpoint resolution.
- getCommand() : CommandInterface
- getConfig() : mixed|null
- Get a client configuration value.
- getCredentials() : PromiseInterface
- Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
- getDatabase() : Result
- getDatabaseAsync() : Promise
- getDataCatalog() : Result
- getDataCatalogAsync() : Promise
- getEndpoint() : UriInterface
- Gets the default endpoint, or base URL, used by the client.
- getEndpointProvider() : mixed
- getEndpointProviderArgs() : array<string|int, mixed>
- Retrieves arguments to be used in endpoint resolution.
- getHandlerList() : HandlerList
- Get the handler list used to transfer commands.
- getIterator() : mixed
- getNamedQuery() : Result
- getNamedQueryAsync() : Promise
- getNotebookMetadata() : Result
- getNotebookMetadataAsync() : Promise
- getPaginator() : mixed
- getPreparedStatement() : Result
- getPreparedStatementAsync() : Promise
- getQueryExecution() : Result
- getQueryExecutionAsync() : Promise
- getQueryResults() : Result
- getQueryResultsAsync() : Promise
- getQueryRuntimeStatistics() : Result
- getQueryRuntimeStatisticsAsync() : Promise
- getRegion() : string
- Get the region to which the client is configured to send requests.
- getSession() : Result
- getSessionAsync() : Promise
- getSessionStatus() : Result
- getSessionStatusAsync() : Promise
- getSignatureProvider() : callable
- Get the signature_provider function of the client.
- getTableMetadata() : Result
- getTableMetadataAsync() : Promise
- getWaiter() : mixed
- getWorkGroup() : Result
- getWorkGroupAsync() : Promise
- importNotebook() : Result
- importNotebookAsync() : Promise
- listApplicationDPUSizes() : Result
- listApplicationDPUSizesAsync() : Promise
- listCalculationExecutions() : Result
- listCalculationExecutionsAsync() : Promise
- listCapacityReservations() : Result
- listCapacityReservationsAsync() : Promise
- listDatabases() : Result
- listDatabasesAsync() : Promise
- listDataCatalogs() : Result
- listDataCatalogsAsync() : Promise
- listEngineVersions() : Result
- listEngineVersionsAsync() : Promise
- listExecutors() : Result
- listExecutorsAsync() : Promise
- listNamedQueries() : Result
- listNamedQueriesAsync() : Promise
- listNotebookMetadata() : Result
- listNotebookMetadataAsync() : Promise
- listNotebookSessions() : Result
- listNotebookSessionsAsync() : Promise
- listPreparedStatements() : Result
- listPreparedStatementsAsync() : Promise
- listQueryExecutions() : Result
- listQueryExecutionsAsync() : Promise
- listSessions() : Result
- listSessionsAsync() : Promise
- listTableMetadata() : Result
- listTableMetadataAsync() : Promise
- listTagsForResource() : Result
- listTagsForResourceAsync() : Promise
- listWorkGroups() : Result
- listWorkGroupsAsync() : Promise
- putCapacityAssignmentConfiguration() : Result
- putCapacityAssignmentConfigurationAsync() : Promise
- startCalculationExecution() : Result
- startCalculationExecutionAsync() : Promise
- startQueryExecution() : Result
- startQueryExecutionAsync() : Promise
- startSession() : Result
- startSessionAsync() : Promise
- stopCalculationExecution() : Result
- stopCalculationExecutionAsync() : Promise
- stopQueryExecution() : Result
- stopQueryExecutionAsync() : Promise
- tagResource() : Result
- tagResourceAsync() : Promise
- terminateSession() : Result
- terminateSessionAsync() : Promise
- untagResource() : Result
- untagResourceAsync() : Promise
- updateCapacityReservation() : Result
- updateCapacityReservationAsync() : Promise
- updateDataCatalog() : Result
- updateDataCatalogAsync() : Promise
- updateNamedQuery() : Result
- updateNamedQueryAsync() : Promise
- updateNotebook() : Result
- updateNotebookAsync() : Promise
- updateNotebookMetadata() : Result
- updateNotebookMetadataAsync() : Promise
- updatePreparedStatement() : Result
- updatePreparedStatementAsync() : Promise
- updateWorkGroup() : Result
- updateWorkGroupAsync() : Promise
- waitUntil() : mixed
Methods
__call()
public
__call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed>
__construct()
The client constructor accepts the following options:
public
__construct(array<string|int, mixed> $args) : mixed
- api_provider: (callable) An optional PHP callable that accepts a type, service, and version argument, and returns an array of corresponding configuration data. The type value can be one of api, waiter, or paginator.
- credentials:
(Aws\Credentials\CredentialsInterface|array|bool|callable) Specifies
the credentials used to sign requests. Provide an
Aws\Credentials\CredentialsInterface object, an associative array of
"key", "secret", and an optional "token" key,
false
to use null credentials, or a callable credentials provider used to create credentials or return null. See Aws\Credentials\CredentialProvider for a list of built-in credentials providers. If no credentials are provided, the SDK will attempt to load them from the environment. - token:
(Aws\Token\TokenInterface|array|bool|callable) Specifies
the token used to authorize requests. Provide an
Aws\Token\TokenInterface object, an associative array of
"token" and an optional "expires" key,
false
to use no token, or a callable token provider used to create a token or return null. See Aws\Token\TokenProvider for a list of built-in token providers. If no token is provided, the SDK will attempt to load one from the environment. - csm:
(Aws\ClientSideMonitoring\ConfigurationInterface|array|callable) Specifies
the credentials used to sign requests. Provide an
Aws\ClientSideMonitoring\ConfigurationInterface object, a callable
configuration provider used to create client-side monitoring configuration,
false
to disable csm, or an associative array with the following keys: enabled: (bool) Set to true to enable client-side monitoring, defaults to false; host: (string) the host location to send monitoring events to, defaults to 127.0.0.1; port: (int) The port used for the host connection, defaults to 31000; client_id: (string) An identifier for this project - debug: (bool|array) Set to true to display debug information when sending requests. Alternatively, you can provide an associative array with the following keys: logfn: (callable) Function that is invoked with log messages; stream_size: (int) When the size of a stream is greater than this number, the stream data will not be logged (set to "0" to not log any stream data); scrub_auth: (bool) Set to false to disable the scrubbing of auth data from the logged messages; http: (bool) Set to false to disable the "debug" feature of lower level HTTP adapters (e.g., verbose curl output).
- stats: (bool|array) Set to true to gather transfer statistics on
requests sent. Alternatively, you can provide an associative array with
the following keys: retries: (bool) Set to false to disable reporting
on retries attempted; http: (bool) Set to true to enable collecting
statistics from lower level HTTP adapters (e.g., values returned in
GuzzleHttp\TransferStats). HTTP handlers must support an
http_stats_receiver
option for this to have an effect; timer: (bool) Set to true to enable a command timer that reports the total wall clock time spent on an operation in seconds. - disable_host_prefix_injection: (bool) Set to true to disable host prefix injection logic for services that use it. This disables the entire prefix injection, including the portions supplied by user-defined parameters. Setting this flag will have no effect on services that do not use host prefix injection.
- endpoint: (string) The full URI of the webservice. This is only required when connecting to a custom endpoint (e.g., a local version of S3).
- endpoint_discovery: (Aws\EndpointDiscovery\ConfigurationInterface, Aws\CacheInterface, array, callable) Settings for endpoint discovery. Provide an instance of Aws\EndpointDiscovery\ConfigurationInterface, an instance Aws\CacheInterface, a callable that provides a promise for a Configuration object, or an associative array with the following keys: enabled: (bool) Set to true to enable endpoint discovery, false to explicitly disable it, defaults to false; cache_limit: (int) The maximum number of keys in the endpoints cache, defaults to 1000.
- endpoint_provider: (callable) An optional PHP callable that accepts a hash of options including a "service" and "region" key and returns NULL or a hash of endpoint data, of which the "endpoint" key is required. See Aws\Endpoint\EndpointProvider for a list of built-in providers.
- handler: (callable) A handler that accepts a command object, request object and returns a promise that is fulfilled with an Aws\ResultInterface object or rejected with an Aws\Exception\AwsException. A handler does not accept a next handler as it is terminal and expected to fulfill a command. If no handler is provided, a default Guzzle handler will be utilized.
- http: (array, default=array(0)) Set to an array of SDK request options to apply to each request (e.g., proxy, verify, etc.).
- http_handler: (callable) An HTTP handler is a function that accepts a PSR-7 request object and returns a promise that is fulfilled with a PSR-7 response object or rejected with an array of exception data. NOTE: This option supersedes any provided "handler" option.
- idempotency_auto_fill: (bool|callable) Set to false to disable SDK to populate parameters that enabled 'idempotencyToken' trait with a random UUID v4 value on your behalf. Using default value 'true' still allows parameter value to be overwritten when provided. Note: auto-fill only works when cryptographically secure random bytes generator functions (random_bytes, openssl_random_pseudo_bytes or mcrypt_create_iv) can be found. You may also provide a callable source of random bytes.
- profile: (string) Allows you to specify which profile to use when credentials are created from the AWS credentials file in your HOME directory. This setting overrides the AWS_PROFILE environment variable. Note: Specifying "profile" will cause the "credentials" key to be ignored.
- region: (string, required) Region to connect to. See http://docs.aws.amazon.com/general/latest/gr/rande.html for a list of available regions.
- retries: (int, Aws\Retry\ConfigurationInterface, Aws\CacheInterface, array, callable) Configures the retry mode and maximum number of allowed retries for a client (pass 0 to disable retries). Provide an integer for 'legacy' mode with the specified number of retries. Otherwise provide an instance of Aws\Retry\ConfigurationInterface, an instance of Aws\CacheInterface, a callable function, or an array with the following keys: mode: (string) Set to 'legacy', 'standard' (uses retry quota management), or 'adapative' (an experimental mode that adds client-side rate limiting to standard mode); max_attempts (int) The maximum number of attempts for a given request.
- scheme: (string, default=string(5) "https") URI scheme to use when
connecting connect. The SDK will utilize "https" endpoints (i.e.,
utilize SSL/TLS connections) by default. You can attempt to connect to
a service over an unencrypted "http" endpoint by setting
scheme
to "http". - signature_provider: (callable) A callable that accepts a signature version name (e.g., "v4"), a service name, and region, and returns a SignatureInterface object or null. This provider is used to create signers utilized by the client. See Aws\Signature\SignatureProvider for a list of built-in providers
- signature_version: (string) A string representing a custom signature version to use with a service (e.g., v4). Note that per/operation signature version MAY override this requested signature version.
- use_aws_shared_config_files: (bool, default=bool(true)) Set to false to disable checking for shared config file in '~/.aws/config' and '~/.aws/credentials'. This will override the AWS_CONFIG_FILE environment variable.
- validate: (bool, default=bool(true)) Set to false to disable client-side parameter validation.
- version: (string, required) The version of the webservice to utilize (e.g., 2006-03-01).
- ua_append: (string, array) To pass custom user agent parameters.
- app_id: (string) an optional application specific identifier that can be set. When set it will be appended to the User-Agent header of every request in the form of App/{AppId}. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id. See https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html for more information on environment variables and shared config settings.
Parameters
- $args : array<string|int, mixed>
-
Client configuration arguments.
Tags
__sleep()
public
__sleep() : mixed
batchGetNamedQuery()
public
batchGetNamedQuery(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultbatchGetNamedQueryAsync()
public
batchGetNamedQueryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisebatchGetPreparedStatement()
public
batchGetPreparedStatement(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultbatchGetPreparedStatementAsync()
public
batchGetPreparedStatementAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisebatchGetQueryExecution()
public
batchGetQueryExecution(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultbatchGetQueryExecutionAsync()
public
batchGetQueryExecutionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecancelCapacityReservation()
public
cancelCapacityReservation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcancelCapacityReservationAsync()
public
cancelCapacityReservationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateCapacityReservation()
public
createCapacityReservation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateCapacityReservationAsync()
public
createCapacityReservationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateDataCatalog()
public
createDataCatalog(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateDataCatalogAsync()
public
createDataCatalogAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateNamedQuery()
public
createNamedQuery(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateNamedQueryAsync()
public
createNamedQueryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateNotebook()
public
createNotebook(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateNotebookAsync()
public
createNotebookAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreatePreparedStatement()
public
createPreparedStatement(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreatePreparedStatementAsync()
public
createPreparedStatementAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreatePresignedNotebookUrl()
public
createPresignedNotebookUrl(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreatePresignedNotebookUrlAsync()
public
createPresignedNotebookUrlAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateWorkGroup()
public
createWorkGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateWorkGroupAsync()
public
createWorkGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteCapacityReservation()
public
deleteCapacityReservation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteCapacityReservationAsync()
public
deleteCapacityReservationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteDataCatalog()
public
deleteDataCatalog(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteDataCatalogAsync()
public
deleteDataCatalogAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteNamedQuery()
public
deleteNamedQuery(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteNamedQueryAsync()
public
deleteNamedQueryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteNotebook()
public
deleteNotebook(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteNotebookAsync()
public
deleteNotebookAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeletePreparedStatement()
public
deletePreparedStatement(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeletePreparedStatementAsync()
public
deletePreparedStatementAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteWorkGroup()
public
deleteWorkGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteWorkGroupAsync()
public
deleteWorkGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseemitDeprecationWarning()
public
static emitDeprecationWarning() : mixed
execute()
public
execute(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
executeAsync()
public
executeAsync(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
exportNotebook()
public
exportNotebook(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultexportNotebookAsync()
public
exportNotebookAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
Promisefactory()
public
static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
- $config : array<string|int, mixed> = []
Tags
Return values
staticgetApi()
public
abstract getApi() : Service
Return values
ServicegetArguments()
Get an array of client constructor arguments used by the client.
public
static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed>getCalculationExecution()
public
getCalculationExecution(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCalculationExecutionAsync()
public
getCalculationExecutionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetCalculationExecutionCode()
public
getCalculationExecutionCode(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCalculationExecutionCodeAsync()
public
getCalculationExecutionCodeAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetCalculationExecutionStatus()
public
getCalculationExecutionStatus(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCalculationExecutionStatusAsync()
public
getCalculationExecutionStatusAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetCapacityAssignmentConfiguration()
public
getCapacityAssignmentConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCapacityAssignmentConfigurationAsync()
public
getCapacityAssignmentConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetCapacityReservation()
public
getCapacityReservation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCapacityReservationAsync()
public
getCapacityReservationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetClientBuiltIns()
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
CommandInterfacegetConfig()
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|nullgetCredentials()
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
PromiseInterfacegetDatabase()
public
getDatabase(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetDatabaseAsync()
public
getDatabaseAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetDataCatalog()
public
getDataCatalog(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetDataCatalogAsync()
public
getDataCatalogAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetEndpoint()
Gets the default endpoint, or base URL, used by the client.
public
getEndpoint() : UriInterface
Return values
UriInterfacegetEndpointProvider()
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
HandlerListgetIterator()
public
getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
getNamedQuery()
public
getNamedQuery(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetNamedQueryAsync()
public
getNamedQueryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetNotebookMetadata()
public
getNotebookMetadata(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetNotebookMetadataAsync()
public
getNotebookMetadataAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetPaginator()
public
getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
getPreparedStatement()
public
getPreparedStatement(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetPreparedStatementAsync()
public
getPreparedStatementAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetQueryExecution()
public
getQueryExecution(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetQueryExecutionAsync()
public
getQueryExecutionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetQueryResults()
public
getQueryResults(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetQueryResultsAsync()
public
getQueryResultsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetQueryRuntimeStatistics()
public
getQueryRuntimeStatistics(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetQueryRuntimeStatisticsAsync()
public
getQueryRuntimeStatisticsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetRegion()
Get the region to which the client is configured to send requests.
public
getRegion() : string
Return values
stringgetSession()
public
getSession(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetSessionAsync()
public
getSessionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetSessionStatus()
public
getSessionStatus(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetSessionStatusAsync()
public
getSessionStatusAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetSignatureProvider()
Get the signature_provider function of the client.
public
final getSignatureProvider() : callable
Return values
callablegetTableMetadata()
public
getTableMetadata(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetTableMetadataAsync()
public
getTableMetadataAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetWaiter()
public
getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
getWorkGroup()
public
getWorkGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetWorkGroupAsync()
public
getWorkGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseimportNotebook()
public
importNotebook(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultimportNotebookAsync()
public
importNotebookAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistApplicationDPUSizes()
public
listApplicationDPUSizes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistApplicationDPUSizesAsync()
public
listApplicationDPUSizesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistCalculationExecutions()
public
listCalculationExecutions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistCalculationExecutionsAsync()
public
listCalculationExecutionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistCapacityReservations()
public
listCapacityReservations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistCapacityReservationsAsync()
public
listCapacityReservationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistDatabases()
public
listDatabases(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistDatabasesAsync()
public
listDatabasesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistDataCatalogs()
public
listDataCatalogs(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistDataCatalogsAsync()
public
listDataCatalogsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistEngineVersions()
public
listEngineVersions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistEngineVersionsAsync()
public
listEngineVersionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistExecutors()
public
listExecutors(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistExecutorsAsync()
public
listExecutorsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistNamedQueries()
public
listNamedQueries(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistNamedQueriesAsync()
public
listNamedQueriesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistNotebookMetadata()
public
listNotebookMetadata(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistNotebookMetadataAsync()
public
listNotebookMetadataAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistNotebookSessions()
public
listNotebookSessions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistNotebookSessionsAsync()
public
listNotebookSessionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistPreparedStatements()
public
listPreparedStatements(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistPreparedStatementsAsync()
public
listPreparedStatementsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistQueryExecutions()
public
listQueryExecutions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistQueryExecutionsAsync()
public
listQueryExecutionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistSessions()
public
listSessions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistSessionsAsync()
public
listSessionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTableMetadata()
public
listTableMetadata(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTableMetadataAsync()
public
listTableMetadataAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTagsForResource()
public
listTagsForResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTagsForResourceAsync()
public
listTagsForResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistWorkGroups()
public
listWorkGroups(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistWorkGroupsAsync()
public
listWorkGroupsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputCapacityAssignmentConfiguration()
public
putCapacityAssignmentConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputCapacityAssignmentConfigurationAsync()
public
putCapacityAssignmentConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisestartCalculationExecution()
public
startCalculationExecution(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultstartCalculationExecutionAsync()
public
startCalculationExecutionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisestartQueryExecution()
public
startQueryExecution(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultstartQueryExecutionAsync()
public
startQueryExecutionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisestartSession()
public
startSession(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultstartSessionAsync()
public
startSessionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisestopCalculationExecution()
public
stopCalculationExecution(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultstopCalculationExecutionAsync()
public
stopCalculationExecutionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisestopQueryExecution()
public
stopQueryExecution(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultstopQueryExecutionAsync()
public
stopQueryExecutionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisetagResource()
public
tagResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResulttagResourceAsync()
public
tagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseterminateSession()
public
terminateSession(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultterminateSessionAsync()
public
terminateSessionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseuntagResource()
public
untagResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultuntagResourceAsync()
public
untagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateCapacityReservation()
public
updateCapacityReservation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateCapacityReservationAsync()
public
updateCapacityReservationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateDataCatalog()
public
updateDataCatalog(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateDataCatalogAsync()
public
updateDataCatalogAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateNamedQuery()
public
updateNamedQuery(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateNamedQueryAsync()
public
updateNamedQueryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateNotebook()
public
updateNotebook(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateNotebookAsync()
public
updateNotebookAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateNotebookMetadata()
public
updateNotebookMetadata(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateNotebookMetadataAsync()
public
updateNotebookMetadataAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdatePreparedStatement()
public
updatePreparedStatement(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdatePreparedStatementAsync()
public
updatePreparedStatementAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateWorkGroup()
public
updateWorkGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateWorkGroupAsync()
public
updateWorkGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisewaitUntil()
public
waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []