Documentation

QuickSightClient extends AwsClient
in package

This client is used to interact with the **Amazon QuickSight** service.

Table of Contents

$aliases  : array<string|int, mixed>
$api  : Service
$config  : array<string|int, mixed>
$credentialProvider  : callable
$defaultRequestOptions  : array<string|int, mixed>
$endpoint  : string
$handlerList  : HandlerList
$region  : string
$signatureProvider  : callable
__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
cancelIngestion()  :
cancelIngestionAsync()  :
createAccountCustomization()  :
createAccountCustomizationAsync()  :
createAnalysis()  :
createAnalysisAsync()  :
createDashboard()  :
createDashboardAsync()  :
createDataSet()  :
createDataSetAsync()  :
createDataSource()  :
createDataSourceAsync()  :
createGroup()  :
createGroupAsync()  :
createGroupMembership()  :
createGroupMembershipAsync()  :
createIAMPolicyAssignment()  :
createIAMPolicyAssignmentAsync()  :
createIngestion()  :
createIngestionAsync()  :
createNamespace()  :
createNamespaceAsync()  :
createTemplate()  :
createTemplateAlias()  :
createTemplateAliasAsync()  :
createTemplateAsync()  :
createTheme()  :
createThemeAlias()  :
createThemeAliasAsync()  :
createThemeAsync()  :
deleteAccountCustomization()  :
deleteAccountCustomizationAsync()  :
deleteAnalysis()  :
deleteAnalysisAsync()  :
deleteDashboard()  :
deleteDashboardAsync()  :
deleteDataSet()  :
deleteDataSetAsync()  :
deleteDataSource()  :
deleteDataSourceAsync()  :
deleteGroup()  :
deleteGroupAsync()  :
deleteGroupMembership()  :
deleteGroupMembershipAsync()  :
deleteIAMPolicyAssignment()  :
deleteIAMPolicyAssignmentAsync()  :
deleteNamespace()  :
deleteNamespaceAsync()  :
deleteTemplate()  :
deleteTemplateAlias()  :
deleteTemplateAliasAsync()  :
deleteTemplateAsync()  :
deleteTheme()  :
deleteThemeAlias()  :
deleteThemeAliasAsync()  :
deleteThemeAsync()  :
deleteUser()  :
deleteUserAsync()  :
deleteUserByPrincipalId()  :
deleteUserByPrincipalIdAsync()  :
describeAccountCustomization()  :
describeAccountCustomizationAsync()  :
describeAccountSettings()  :
describeAccountSettingsAsync()  :
describeAnalysis()  :
describeAnalysisAsync()  :
describeAnalysisPermissions()  :
describeAnalysisPermissionsAsync()  :
describeDashboard()  :
describeDashboardAsync()  :
describeDashboardPermissions()  :
describeDashboardPermissionsAsync()  :
describeDataSet()  :
describeDataSetAsync()  :
describeDataSetPermissions()  :
describeDataSetPermissionsAsync()  :
describeDataSource()  :
describeDataSourceAsync()  :
describeDataSourcePermissions()  :
describeDataSourcePermissionsAsync()  :
describeGroup()  :
describeGroupAsync()  :
describeIAMPolicyAssignment()  :
describeIAMPolicyAssignmentAsync()  :
describeIngestion()  :
describeIngestionAsync()  :
describeNamespace()  :
describeNamespaceAsync()  :
describeTemplate()  :
describeTemplateAlias()  :
describeTemplateAliasAsync()  :
describeTemplateAsync()  :
describeTemplatePermissions()  :
describeTemplatePermissionsAsync()  :
describeTheme()  :
describeThemeAlias()  :
describeThemeAliasAsync()  :
describeThemeAsync()  :
describeThemePermissions()  :
describeThemePermissionsAsync()  :
describeUser()  :
describeUserAsync()  :
execute()  : mixed
executeAsync()  : mixed
factory()  : static
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
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.
getDashboardEmbedUrl()  :
getDashboardEmbedUrlAsync()  :
getEndpoint()  : UriInterface
Gets the default endpoint, or base URL, used by the client.
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.
getSessionEmbedUrl()  :
getSessionEmbedUrlAsync()  :
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getWaiter()  : mixed
listAnalyses()  :
listAnalysesAsync()  :
listDashboards()  :
listDashboardsAsync()  :
listDashboardVersions()  :
listDashboardVersionsAsync()  :
listDataSets()  :
listDataSetsAsync()  :
listDataSources()  :
listDataSourcesAsync()  :
listGroupMemberships()  :
listGroupMembershipsAsync()  :
listGroups()  :
listGroupsAsync()  :
listIAMPolicyAssignments()  :
listIAMPolicyAssignmentsAsync()  :
listIAMPolicyAssignmentsForUser()  :
listIAMPolicyAssignmentsForUserAsync()  :
listIngestions()  :
listIngestionsAsync()  :
listNamespaces()  :
listNamespacesAsync()  :
listTagsForResource()  :
listTagsForResourceAsync()  :
listTemplateAliases()  :
listTemplateAliasesAsync()  :
listTemplates()  :
listTemplatesAsync()  :
listTemplateVersions()  :
listTemplateVersionsAsync()  :
listThemeAliases()  :
listThemeAliasesAsync()  :
listThemes()  :
listThemesAsync()  :
listThemeVersions()  :
listThemeVersionsAsync()  :
listUserGroups()  :
listUserGroupsAsync()  :
listUsers()  :
listUsersAsync()  :
registerUser()  :
registerUserAsync()  :
restoreAnalysis()  :
restoreAnalysisAsync()  :
searchAnalyses()  :
searchAnalysesAsync()  :
searchDashboards()  :
searchDashboardsAsync()  :
tagResource()  :
tagResourceAsync()  :
untagResource()  :
untagResourceAsync()  :
updateAccountCustomization()  :
updateAccountCustomizationAsync()  :
updateAccountSettings()  :
updateAccountSettingsAsync()  :
updateAnalysis()  :
updateAnalysisAsync()  :
updateAnalysisPermissions()  :
updateAnalysisPermissionsAsync()  :
updateDashboard()  :
updateDashboardAsync()  :
updateDashboardPermissions()  :
updateDashboardPermissionsAsync()  :
updateDashboardPublishedVersion()  :
updateDashboardPublishedVersionAsync()  :
updateDataSet()  :
updateDataSetAsync()  :
updateDataSetPermissions()  :
updateDataSetPermissionsAsync()  :
updateDataSource()  :
updateDataSourceAsync()  :
updateDataSourcePermissions()  :
updateDataSourcePermissionsAsync()  :
updateGroup()  :
updateGroupAsync()  :
updateIAMPolicyAssignment()  :
updateIAMPolicyAssignmentAsync()  :
updateTemplate()  :
updateTemplateAlias()  :
updateTemplateAliasAsync()  :
updateTemplateAsync()  :
updateTemplatePermissions()  :
updateTemplatePermissionsAsync()  :
updateTheme()  :
updateThemeAlias()  :
updateThemeAliasAsync()  :
updateThemeAsync()  :
updateThemePermissions()  :
updateThemePermissionsAsync()  :
updateUser()  :
updateUserAsync()  :
waitUntil()  : mixed
addEndpointDiscoveryMiddleware()  : mixed
addEndpointParameterMiddleware()  : mixed
addInvocationId()  : mixed
addSignatureMiddleware()  : mixed
addStreamRequestPayload()  : mixed
loadAliases()  : mixed
parseClass()  : array<string|int, mixed>
Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".

Properties

$aliases

private array<string|int, mixed> $aliases

$config

private array<string|int, mixed> $config

$credentialProvider

private callable $credentialProvider

$defaultRequestOptions

private array<string|int, mixed> $defaultRequestOptions

$signatureProvider

private callable $signatureProvider

Methods

__call()

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

__construct()

The client constructor accepts the following options:

public __construct(array<string|int, mixed> $args) : mixed
  • api_provider: (callable) An optional PHP callable that accepts a type, service, and version argument, and returns an array of corresponding configuration data. The type value can be one of api, waiter, or paginator.
  • credentials: (Aws\Credentials\CredentialsInterface|array|bool|callable) Specifies the credentials used to sign requests. Provide an Aws\Credentials\CredentialsInterface object, an associative array of "key", "secret", and an optional "token" key, 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.
  • 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).
Parameters
$args : array<string|int, mixed>

Client configuration arguments.

Tags
throws
InvalidArgumentException

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

Return values
mixed

__sleep()

public __sleep() : mixed
Return values
mixed

cancelIngestion()

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

cancelIngestionAsync()

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

createAccountCustomization()

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

createAccountCustomizationAsync()

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

createAnalysis()

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

createAnalysisAsync()

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

createDashboard()

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

createDashboardAsync()

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

createDataSet()

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

createDataSetAsync()

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

createDataSource()

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

createDataSourceAsync()

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

createGroup()

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

createGroupAsync()

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

createGroupMembership()

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

createGroupMembershipAsync()

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

createIAMPolicyAssignment()

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

createIAMPolicyAssignmentAsync()

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

createIngestion()

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

createIngestionAsync()

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

createNamespace()

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

createNamespaceAsync()

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

createTemplate()

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

createTemplateAlias()

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

createTemplateAliasAsync()

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

createTemplateAsync()

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

createTheme()

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

createThemeAlias()

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

createThemeAliasAsync()

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

createThemeAsync()

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

deleteAccountCustomization()

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

deleteAccountCustomizationAsync()

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

deleteAnalysis()

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

deleteAnalysisAsync()

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

deleteDashboard()

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

deleteDashboardAsync()

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

deleteDataSet()

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

deleteDataSetAsync()

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

deleteDataSource()

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

deleteDataSourceAsync()

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

deleteGroup()

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

deleteGroupAsync()

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

deleteGroupMembership()

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

deleteGroupMembershipAsync()

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

deleteIAMPolicyAssignment()

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

deleteIAMPolicyAssignmentAsync()

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

deleteNamespace()

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

deleteNamespaceAsync()

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

deleteTemplate()

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

deleteTemplateAlias()

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

deleteTemplateAliasAsync()

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

deleteTemplateAsync()

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

deleteTheme()

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

deleteThemeAlias()

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

deleteThemeAliasAsync()

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

deleteThemeAsync()

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

deleteUser()

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

deleteUserAsync()

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

deleteUserByPrincipalId()

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

deleteUserByPrincipalIdAsync()

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

describeAccountCustomization()

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

describeAccountCustomizationAsync()

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

describeAccountSettings()

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

describeAccountSettingsAsync()

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

describeAnalysis()

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

describeAnalysisAsync()

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

describeAnalysisPermissions()

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

describeAnalysisPermissionsAsync()

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

describeDashboard()

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

describeDashboardAsync()

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

describeDashboardPermissions()

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

describeDashboardPermissionsAsync()

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

describeDataSet()

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

describeDataSetAsync()

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

describeDataSetPermissions()

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

describeDataSetPermissionsAsync()

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

describeDataSource()

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

describeDataSourceAsync()

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

describeDataSourcePermissions()

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

describeDataSourcePermissionsAsync()

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

describeGroup()

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

describeGroupAsync()

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

describeIAMPolicyAssignment()

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

describeIAMPolicyAssignmentAsync()

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

describeIngestion()

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

describeIngestionAsync()

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

describeNamespace()

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

describeNamespaceAsync()

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

describeTemplate()

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

describeTemplateAlias()

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

describeTemplateAliasAsync()

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

describeTemplateAsync()

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

describeTemplatePermissions()

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

describeTemplatePermissionsAsync()

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

describeTheme()

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

describeThemeAlias()

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

describeThemeAliasAsync()

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

describeThemeAsync()

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

describeThemePermissions()

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

describeThemePermissionsAsync()

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

describeUser()

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

describeUserAsync()

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

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>

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

getDashboardEmbedUrl()

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

getDashboardEmbedUrlAsync()

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

getHandlerList()

Get the handler list used to transfer commands.

public getHandlerList() : HandlerList

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

Return values
HandlerList

getIterator()

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

getPaginator()

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

getRegion()

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

public getRegion() : string
Return values
string

getSessionEmbedUrl()

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

getSessionEmbedUrlAsync()

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

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable

getWaiter()

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

listAnalyses()

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

listAnalysesAsync()

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

listDashboards()

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

listDashboardsAsync()

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

listDashboardVersions()

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

listDashboardVersionsAsync()

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

listDataSets()

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

listDataSetsAsync()

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

listDataSources()

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

listDataSourcesAsync()

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

listGroupMemberships()

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

listGroupMembershipsAsync()

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

listGroups()

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

listGroupsAsync()

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

listIAMPolicyAssignments()

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

listIAMPolicyAssignmentsAsync()

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

listIAMPolicyAssignmentsForUser()

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

listIAMPolicyAssignmentsForUserAsync()

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

listIngestions()

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

listIngestionsAsync()

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

listNamespaces()

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

listNamespacesAsync()

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

listTagsForResource()

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

listTagsForResourceAsync()

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

listTemplateAliases()

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

listTemplateAliasesAsync()

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

listTemplates()

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

listTemplatesAsync()

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

listTemplateVersions()

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

listTemplateVersionsAsync()

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

listThemeAliases()

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

listThemeAliasesAsync()

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

listThemes()

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

listThemesAsync()

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

listThemeVersions()

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

listThemeVersionsAsync()

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

listUserGroups()

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

listUserGroupsAsync()

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

listUsers()

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

listUsersAsync()

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

registerUser()

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

registerUserAsync()

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

restoreAnalysis()

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

restoreAnalysisAsync()

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

searchAnalyses()

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

searchAnalysesAsync()

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

searchDashboards()

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

searchDashboardsAsync()

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

tagResource()

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

tagResourceAsync()

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

untagResource()

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

untagResourceAsync()

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

updateAccountCustomization()

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

updateAccountCustomizationAsync()

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

updateAccountSettings()

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

updateAccountSettingsAsync()

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

updateAnalysis()

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

updateAnalysisAsync()

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

updateAnalysisPermissions()

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

updateAnalysisPermissionsAsync()

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

updateDashboard()

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

updateDashboardAsync()

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

updateDashboardPermissions()

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

updateDashboardPermissionsAsync()

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

updateDashboardPublishedVersion()

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

updateDashboardPublishedVersionAsync()

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

updateDataSet()

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

updateDataSetAsync()

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

updateDataSetPermissions()

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

updateDataSetPermissionsAsync()

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

updateDataSource()

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

updateDataSourceAsync()

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

updateDataSourcePermissions()

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

updateDataSourcePermissionsAsync()

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

updateGroup()

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

updateGroupAsync()

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

updateIAMPolicyAssignment()

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

updateIAMPolicyAssignmentAsync()

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

updateTemplate()

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

updateTemplateAlias()

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

updateTemplateAliasAsync()

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

updateTemplateAsync()

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

updateTemplatePermissions()

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

updateTemplatePermissionsAsync()

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

updateTheme()

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

updateThemeAlias()

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

updateThemeAliasAsync()

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

updateThemeAsync()

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

updateThemePermissions()

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

updateThemePermissionsAsync()

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

updateUser()

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

updateUserAsync()

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

waitUntil()

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

addEndpointDiscoveryMiddleware()

private addEndpointDiscoveryMiddleware(mixed $config, mixed $args) : mixed
Parameters
$config : mixed
$args : mixed
Return values
mixed

addEndpointParameterMiddleware()

private addEndpointParameterMiddleware(mixed $args) : mixed
Parameters
$args : mixed
Return values
mixed

addInvocationId()

private addInvocationId() : mixed
Return values
mixed

addSignatureMiddleware()

private addSignatureMiddleware() : mixed
Return values
mixed

addStreamRequestPayload()

private addStreamRequestPayload() : mixed
Return values
mixed

loadAliases()

private loadAliases([mixed $file = null ]) : mixed
Parameters
$file : mixed = null
Return values
mixed

parseClass()

Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".

private parseClass() : array<string|int, mixed>
Return values
array<string|int, mixed>

Search results