SDK for PHP 3.x

CleanRoomsClient extends AwsClient
in package

This client is used to interact with the AWS Clean Rooms Service service.

Supported API Versions

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

Table of Contents

Methods

__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
batchGetCollaborationAnalysisTemplate()  : Result
batchGetCollaborationAnalysisTemplateAsync()  : Promise
batchGetSchema()  : Result
batchGetSchemaAnalysisRule()  : Result
batchGetSchemaAnalysisRuleAsync()  : Promise
batchGetSchemaAsync()  : Promise
createAnalysisTemplate()  : Result
createAnalysisTemplateAsync()  : Promise
createCollaboration()  : Result
createCollaborationAsync()  : Promise
createConfiguredAudienceModelAssociation()  : Result
createConfiguredAudienceModelAssociationAsync()  : Promise
createConfiguredTable()  : Result
createConfiguredTableAnalysisRule()  : Result
createConfiguredTableAnalysisRuleAsync()  : Promise
createConfiguredTableAssociation()  : Result
createConfiguredTableAssociationAsync()  : Promise
createConfiguredTableAsync()  : Promise
createMembership()  : Result
createMembershipAsync()  : Promise
createPrivacyBudgetTemplate()  : Result
createPrivacyBudgetTemplateAsync()  : Promise
deleteAnalysisTemplate()  : Result
deleteAnalysisTemplateAsync()  : Promise
deleteCollaboration()  : Result
deleteCollaborationAsync()  : Promise
deleteConfiguredAudienceModelAssociation()  : Result
deleteConfiguredAudienceModelAssociationAsync()  : Promise
deleteConfiguredTable()  : Result
deleteConfiguredTableAnalysisRule()  : Result
deleteConfiguredTableAnalysisRuleAsync()  : Promise
deleteConfiguredTableAssociation()  : Result
deleteConfiguredTableAssociationAsync()  : Promise
deleteConfiguredTableAsync()  : Promise
deleteMember()  : Result
deleteMemberAsync()  : Promise
deleteMembership()  : Result
deleteMembershipAsync()  : Promise
deletePrivacyBudgetTemplate()  : Result
deletePrivacyBudgetTemplateAsync()  : Promise
emitDeprecationWarning()  : mixed
execute()  : mixed
executeAsync()  : mixed
factory()  : static
getAnalysisTemplate()  : Result
getAnalysisTemplateAsync()  : Promise
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getClientBuiltIns()  : array<string|int, mixed>
Provides the set of built-in keys and values used for endpoint resolution
getClientContextParams()  : array<string|int, mixed>
Provides the set of service context parameter key-value pairs used for endpoint resolution.
getCollaboration()  : Result
getCollaborationAnalysisTemplate()  : Result
getCollaborationAnalysisTemplateAsync()  : Promise
getCollaborationAsync()  : Promise
getCollaborationConfiguredAudienceModelAssociation()  : Result
getCollaborationConfiguredAudienceModelAssociationAsync()  : Promise
getCollaborationPrivacyBudgetTemplate()  : Result
getCollaborationPrivacyBudgetTemplateAsync()  : Promise
getCommand()  : CommandInterface
getConfig()  : mixed|null
Get a client configuration value.
getConfiguredAudienceModelAssociation()  : Result
getConfiguredAudienceModelAssociationAsync()  : Promise
getConfiguredTable()  : Result
getConfiguredTableAnalysisRule()  : Result
getConfiguredTableAnalysisRuleAsync()  : Promise
getConfiguredTableAssociation()  : Result
getConfiguredTableAssociationAsync()  : Promise
getConfiguredTableAsync()  : Promise
getCredentials()  : PromiseInterface
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
getEndpoint()  : UriInterface
Gets the default endpoint, or base URL, used by the client.
getEndpointProvider()  : mixed
getEndpointProviderArgs()  : array<string|int, mixed>
Retrieves arguments to be used in endpoint resolution.
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getIterator()  : mixed
getMembership()  : Result
getMembershipAsync()  : Promise
getPaginator()  : mixed
getPrivacyBudgetTemplate()  : Result
getPrivacyBudgetTemplateAsync()  : Promise
getProtectedQuery()  : Result
getProtectedQueryAsync()  : Promise
getRegion()  : string
Get the region to which the client is configured to send requests.
getSchema()  : Result
getSchemaAnalysisRule()  : Result
getSchemaAnalysisRuleAsync()  : Promise
getSchemaAsync()  : Promise
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getWaiter()  : mixed
listAnalysisTemplates()  : Result
listAnalysisTemplatesAsync()  : Promise
listCollaborationAnalysisTemplates()  : Result
listCollaborationAnalysisTemplatesAsync()  : Promise
listCollaborationConfiguredAudienceModelAssociations()  : Result
listCollaborationConfiguredAudienceModelAssociationsAsync()  : Promise
listCollaborationPrivacyBudgets()  : Result
listCollaborationPrivacyBudgetsAsync()  : Promise
listCollaborationPrivacyBudgetTemplates()  : Result
listCollaborationPrivacyBudgetTemplatesAsync()  : Promise
listCollaborations()  : Result
listCollaborationsAsync()  : Promise
listConfiguredAudienceModelAssociations()  : Result
listConfiguredAudienceModelAssociationsAsync()  : Promise
listConfiguredTableAssociations()  : Result
listConfiguredTableAssociationsAsync()  : Promise
listConfiguredTables()  : Result
listConfiguredTablesAsync()  : Promise
listMembers()  : Result
listMembersAsync()  : Promise
listMemberships()  : Result
listMembershipsAsync()  : Promise
listPrivacyBudgets()  : Result
listPrivacyBudgetsAsync()  : Promise
listPrivacyBudgetTemplates()  : Result
listPrivacyBudgetTemplatesAsync()  : Promise
listProtectedQueries()  : Result
listProtectedQueriesAsync()  : Promise
listSchemas()  : Result
listSchemasAsync()  : Promise
listTagsForResource()  : Result
listTagsForResourceAsync()  : Promise
previewPrivacyImpact()  : Result
previewPrivacyImpactAsync()  : Promise
startProtectedQuery()  : Result
startProtectedQueryAsync()  : Promise
tagResource()  : Result
tagResourceAsync()  : Promise
untagResource()  : Result
untagResourceAsync()  : Promise
updateAnalysisTemplate()  : Result
updateAnalysisTemplateAsync()  : Promise
updateCollaboration()  : Result
updateCollaborationAsync()  : Promise
updateConfiguredAudienceModelAssociation()  : Result
updateConfiguredAudienceModelAssociationAsync()  : Promise
updateConfiguredTable()  : Result
updateConfiguredTableAnalysisRule()  : Result
updateConfiguredTableAnalysisRuleAsync()  : Promise
updateConfiguredTableAssociation()  : Result
updateConfiguredTableAssociationAsync()  : Promise
updateConfiguredTableAsync()  : Promise
updateMembership()  : Result
updateMembershipAsync()  : Promise
updatePrivacyBudgetTemplate()  : Result
updatePrivacyBudgetTemplateAsync()  : Promise
updateProtectedQuery()  : Result
updateProtectedQueryAsync()  : Promise
waitUntil()  : mixed

Methods

__call()

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

__construct()

The client constructor accepts the following options:

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

Client configuration arguments.

Tags
throws
InvalidArgumentException

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

__sleep()

public __sleep() : mixed

batchGetCollaborationAnalysisTemplate()

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

batchGetCollaborationAnalysisTemplateAsync()

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

batchGetSchema()

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

batchGetSchemaAnalysisRule()

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

batchGetSchemaAnalysisRuleAsync()

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

batchGetSchemaAsync()

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

createAnalysisTemplate()

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

createAnalysisTemplateAsync()

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

createCollaboration()

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

createCollaborationAsync()

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

createConfiguredAudienceModelAssociation()

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

createConfiguredAudienceModelAssociationAsync()

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

createConfiguredTable()

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

createConfiguredTableAnalysisRule()

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

createConfiguredTableAnalysisRuleAsync()

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

createConfiguredTableAssociation()

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

createConfiguredTableAssociationAsync()

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

createConfiguredTableAsync()

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

createMembership()

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

createMembershipAsync()

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

createPrivacyBudgetTemplate()

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

createPrivacyBudgetTemplateAsync()

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

deleteAnalysisTemplate()

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

deleteAnalysisTemplateAsync()

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

deleteCollaboration()

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

deleteCollaborationAsync()

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

deleteConfiguredAudienceModelAssociation()

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

deleteConfiguredAudienceModelAssociationAsync()

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

deleteConfiguredTable()

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

deleteConfiguredTableAnalysisRule()

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

deleteConfiguredTableAnalysisRuleAsync()

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

deleteConfiguredTableAssociation()

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

deleteConfiguredTableAssociationAsync()

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

deleteConfiguredTableAsync()

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

deleteMember()

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

deleteMemberAsync()

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

deleteMembership()

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

deleteMembershipAsync()

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

deletePrivacyBudgetTemplate()

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

deletePrivacyBudgetTemplateAsync()

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

emitDeprecationWarning()

public static emitDeprecationWarning() : mixed

factory()

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

getAnalysisTemplate()

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

getAnalysisTemplateAsync()

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

getArguments()

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

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

getClientBuiltIns()

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

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

getClientContextParams()

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

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

getCollaboration()

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

getCollaborationAnalysisTemplate()

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

getCollaborationAnalysisTemplateAsync()

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

getCollaborationAsync()

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

getCollaborationConfiguredAudienceModelAssociation()

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

getCollaborationConfiguredAudienceModelAssociationAsync()

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

getCollaborationPrivacyBudgetTemplate()

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

getCollaborationPrivacyBudgetTemplateAsync()

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

getCommand()

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

getConfig()

Get a client configuration value.

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

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

Return values
mixed|null

getConfiguredAudienceModelAssociation()

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

getConfiguredAudienceModelAssociationAsync()

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

getConfiguredTable()

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

getConfiguredTableAnalysisRule()

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

getConfiguredTableAnalysisRuleAsync()

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

getConfiguredTableAssociation()

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

getConfiguredTableAssociationAsync()

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

getConfiguredTableAsync()

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

getCredentials()

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

public getCredentials() : PromiseInterface

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

Return values
PromiseInterface

getEndpoint()

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

public getEndpoint() : UriInterface
Return values
UriInterface

getEndpointProvider()

public getEndpointProvider() : mixed

getEndpointProviderArgs()

Retrieves arguments to be used in endpoint resolution.

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

getHandlerList()

Get the handler list used to transfer commands.

public getHandlerList() : HandlerList

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

Return values
HandlerList

getIterator()

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

getMembership()

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

getMembershipAsync()

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

getPaginator()

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

getPrivacyBudgetTemplate()

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

getPrivacyBudgetTemplateAsync()

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

getProtectedQuery()

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

getProtectedQueryAsync()

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

getRegion()

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

public getRegion() : string
Return values
string

getSchema()

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

getSchemaAnalysisRule()

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

getSchemaAnalysisRuleAsync()

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

getSchemaAsync()

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

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable

getWaiter()

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

listAnalysisTemplates()

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

listAnalysisTemplatesAsync()

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

listCollaborationAnalysisTemplates()

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

listCollaborationAnalysisTemplatesAsync()

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

listCollaborationConfiguredAudienceModelAssociations()

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

listCollaborationConfiguredAudienceModelAssociationsAsync()

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

listCollaborationPrivacyBudgets()

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

listCollaborationPrivacyBudgetsAsync()

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

listCollaborationPrivacyBudgetTemplates()

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

listCollaborationPrivacyBudgetTemplatesAsync()

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

listCollaborations()

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

listCollaborationsAsync()

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

listConfiguredAudienceModelAssociations()

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

listConfiguredAudienceModelAssociationsAsync()

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

listConfiguredTableAssociations()

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

listConfiguredTableAssociationsAsync()

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

listConfiguredTables()

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

listConfiguredTablesAsync()

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

listMembers()

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

listMembersAsync()

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

listMemberships()

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

listMembershipsAsync()

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

listPrivacyBudgets()

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

listPrivacyBudgetsAsync()

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

listPrivacyBudgetTemplates()

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

listPrivacyBudgetTemplatesAsync()

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

listProtectedQueries()

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

listProtectedQueriesAsync()

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

listSchemas()

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

listSchemasAsync()

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

listTagsForResource()

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

listTagsForResourceAsync()

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

previewPrivacyImpact()

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

previewPrivacyImpactAsync()

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

startProtectedQuery()

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

startProtectedQueryAsync()

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

tagResource()

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

tagResourceAsync()

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

untagResource()

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

untagResourceAsync()

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

updateAnalysisTemplate()

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

updateAnalysisTemplateAsync()

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

updateCollaboration()

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

updateCollaborationAsync()

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

updateConfiguredAudienceModelAssociation()

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

updateConfiguredAudienceModelAssociationAsync()

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

updateConfiguredTable()

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

updateConfiguredTableAnalysisRule()

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

updateConfiguredTableAnalysisRuleAsync()

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

updateConfiguredTableAssociation()

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

updateConfiguredTableAssociationAsync()

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

updateConfiguredTableAsync()

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

updateMembership()

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

updateMembershipAsync()

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

updatePrivacyBudgetTemplate()

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

updatePrivacyBudgetTemplateAsync()

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

updateProtectedQuery()

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

updateProtectedQueryAsync()

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

waitUntil()

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