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.
- BatchGetCollaborationAnalysisTemplate
- BatchGetSchema
- BatchGetSchemaAnalysisRule
- CreateAnalysisTemplate
- CreateCollaboration
- CreateConfiguredAudienceModelAssociation
- CreateConfiguredTable
- CreateConfiguredTableAnalysisRule
- CreateConfiguredTableAssociation
- CreateMembership
- CreatePrivacyBudgetTemplate
- DeleteAnalysisTemplate
- DeleteCollaboration
- DeleteConfiguredAudienceModelAssociation
- DeleteConfiguredTable
- DeleteConfiguredTableAnalysisRule
- DeleteConfiguredTableAssociation
- DeleteMember
- DeleteMembership
- DeletePrivacyBudgetTemplate
- GetAnalysisTemplate
- GetCollaboration
- GetCollaborationAnalysisTemplate
- GetCollaborationConfiguredAudienceModelAssociation
- GetCollaborationPrivacyBudgetTemplate
- GetConfiguredAudienceModelAssociation
- GetConfiguredTable
- GetConfiguredTableAnalysisRule
- GetConfiguredTableAssociation
- GetMembership
- GetPrivacyBudgetTemplate
- GetProtectedQuery
- GetSchema
- GetSchemaAnalysisRule
- ListAnalysisTemplates
- ListCollaborationAnalysisTemplates
- ListCollaborationConfiguredAudienceModelAssociations
- ListCollaborationPrivacyBudgetTemplates
- ListCollaborationPrivacyBudgets
- ListCollaborations
- ListConfiguredAudienceModelAssociations
- ListConfiguredTableAssociations
- ListConfiguredTables
- ListMembers
- ListMemberships
- ListPrivacyBudgetTemplates
- ListPrivacyBudgets
- ListProtectedQueries
- ListSchemas
- ListTagsForResource
- PreviewPrivacyImpact
- StartProtectedQuery
- TagResource
- UntagResource
- UpdateAnalysisTemplate
- UpdateCollaboration
- UpdateConfiguredAudienceModelAssociation
- UpdateConfiguredTable
- UpdateConfiguredTableAnalysisRule
- UpdateConfiguredTableAssociation
- UpdateMembership
- UpdatePrivacyBudgetTemplate
- UpdateProtectedQuery
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
__sleep()
public
__sleep() : mixed
batchGetCollaborationAnalysisTemplate()
public
batchGetCollaborationAnalysisTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultbatchGetCollaborationAnalysisTemplateAsync()
public
batchGetCollaborationAnalysisTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisebatchGetSchema()
public
batchGetSchema(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultbatchGetSchemaAnalysisRule()
public
batchGetSchemaAnalysisRule(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultbatchGetSchemaAnalysisRuleAsync()
public
batchGetSchemaAnalysisRuleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisebatchGetSchemaAsync()
public
batchGetSchemaAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateAnalysisTemplate()
public
createAnalysisTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateAnalysisTemplateAsync()
public
createAnalysisTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateCollaboration()
public
createCollaboration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateCollaborationAsync()
public
createCollaborationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateConfiguredAudienceModelAssociation()
public
createConfiguredAudienceModelAssociation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateConfiguredAudienceModelAssociationAsync()
public
createConfiguredAudienceModelAssociationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateConfiguredTable()
public
createConfiguredTable(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateConfiguredTableAnalysisRule()
public
createConfiguredTableAnalysisRule(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateConfiguredTableAnalysisRuleAsync()
public
createConfiguredTableAnalysisRuleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateConfiguredTableAssociation()
public
createConfiguredTableAssociation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateConfiguredTableAssociationAsync()
public
createConfiguredTableAssociationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateConfiguredTableAsync()
public
createConfiguredTableAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateMembership()
public
createMembership(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateMembershipAsync()
public
createMembershipAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreatePrivacyBudgetTemplate()
public
createPrivacyBudgetTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreatePrivacyBudgetTemplateAsync()
public
createPrivacyBudgetTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteAnalysisTemplate()
public
deleteAnalysisTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteAnalysisTemplateAsync()
public
deleteAnalysisTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteCollaboration()
public
deleteCollaboration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteCollaborationAsync()
public
deleteCollaborationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteConfiguredAudienceModelAssociation()
public
deleteConfiguredAudienceModelAssociation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteConfiguredAudienceModelAssociationAsync()
public
deleteConfiguredAudienceModelAssociationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteConfiguredTable()
public
deleteConfiguredTable(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteConfiguredTableAnalysisRule()
public
deleteConfiguredTableAnalysisRule(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteConfiguredTableAnalysisRuleAsync()
public
deleteConfiguredTableAnalysisRuleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteConfiguredTableAssociation()
public
deleteConfiguredTableAssociation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteConfiguredTableAssociationAsync()
public
deleteConfiguredTableAssociationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteConfiguredTableAsync()
public
deleteConfiguredTableAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteMember()
public
deleteMember(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteMemberAsync()
public
deleteMemberAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteMembership()
public
deleteMembership(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteMembershipAsync()
public
deleteMembershipAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeletePrivacyBudgetTemplate()
public
deletePrivacyBudgetTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeletePrivacyBudgetTemplateAsync()
public
deletePrivacyBudgetTemplateAsync(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
factory()
public
static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
- $config : array<string|int, mixed> = []
Tags
Return values
staticgetAnalysisTemplate()
public
getAnalysisTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetAnalysisTemplateAsync()
public
getAnalysisTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetApi()
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>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
ResultgetCollaborationAnalysisTemplate()
public
getCollaborationAnalysisTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCollaborationAnalysisTemplateAsync()
public
getCollaborationAnalysisTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetCollaborationAsync()
public
getCollaborationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetCollaborationConfiguredAudienceModelAssociation()
public
getCollaborationConfiguredAudienceModelAssociation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCollaborationConfiguredAudienceModelAssociationAsync()
public
getCollaborationConfiguredAudienceModelAssociationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetCollaborationPrivacyBudgetTemplate()
public
getCollaborationPrivacyBudgetTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCollaborationPrivacyBudgetTemplateAsync()
public
getCollaborationPrivacyBudgetTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetCommand()
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|nullgetConfiguredAudienceModelAssociation()
public
getConfiguredAudienceModelAssociation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetConfiguredAudienceModelAssociationAsync()
public
getConfiguredAudienceModelAssociationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetConfiguredTable()
public
getConfiguredTable(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetConfiguredTableAnalysisRule()
public
getConfiguredTableAnalysisRule(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetConfiguredTableAnalysisRuleAsync()
public
getConfiguredTableAnalysisRuleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetConfiguredTableAssociation()
public
getConfiguredTableAssociation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetConfiguredTableAssociationAsync()
public
getConfiguredTableAssociationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetConfiguredTableAsync()
public
getConfiguredTableAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetCredentials()
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
PromiseInterfacegetEndpoint()
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> = []
getMembership()
public
getMembership(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetMembershipAsync()
public
getMembershipAsync(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> = []
getPrivacyBudgetTemplate()
public
getPrivacyBudgetTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetPrivacyBudgetTemplateAsync()
public
getPrivacyBudgetTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetProtectedQuery()
public
getProtectedQuery(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetProtectedQueryAsync()
public
getProtectedQueryAsync(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
stringgetSchema()
public
getSchema(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetSchemaAnalysisRule()
public
getSchemaAnalysisRule(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetSchemaAnalysisRuleAsync()
public
getSchemaAnalysisRuleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetSchemaAsync()
public
getSchemaAsync(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
callablegetWaiter()
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
ResultlistAnalysisTemplatesAsync()
public
listAnalysisTemplatesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistCollaborationAnalysisTemplates()
public
listCollaborationAnalysisTemplates(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistCollaborationAnalysisTemplatesAsync()
public
listCollaborationAnalysisTemplatesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistCollaborationConfiguredAudienceModelAssociations()
public
listCollaborationConfiguredAudienceModelAssociations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistCollaborationConfiguredAudienceModelAssociationsAsync()
public
listCollaborationConfiguredAudienceModelAssociationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistCollaborationPrivacyBudgets()
public
listCollaborationPrivacyBudgets(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistCollaborationPrivacyBudgetsAsync()
public
listCollaborationPrivacyBudgetsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistCollaborationPrivacyBudgetTemplates()
public
listCollaborationPrivacyBudgetTemplates(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistCollaborationPrivacyBudgetTemplatesAsync()
public
listCollaborationPrivacyBudgetTemplatesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistCollaborations()
public
listCollaborations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistCollaborationsAsync()
public
listCollaborationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistConfiguredAudienceModelAssociations()
public
listConfiguredAudienceModelAssociations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistConfiguredAudienceModelAssociationsAsync()
public
listConfiguredAudienceModelAssociationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistConfiguredTableAssociations()
public
listConfiguredTableAssociations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistConfiguredTableAssociationsAsync()
public
listConfiguredTableAssociationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistConfiguredTables()
public
listConfiguredTables(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistConfiguredTablesAsync()
public
listConfiguredTablesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistMembers()
public
listMembers(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistMembersAsync()
public
listMembersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistMemberships()
public
listMemberships(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistMembershipsAsync()
public
listMembershipsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistPrivacyBudgets()
public
listPrivacyBudgets(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistPrivacyBudgetsAsync()
public
listPrivacyBudgetsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistPrivacyBudgetTemplates()
public
listPrivacyBudgetTemplates(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistPrivacyBudgetTemplatesAsync()
public
listPrivacyBudgetTemplatesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistProtectedQueries()
public
listProtectedQueries(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistProtectedQueriesAsync()
public
listProtectedQueriesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistSchemas()
public
listSchemas(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistSchemasAsync()
public
listSchemasAsync(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
PromisepreviewPrivacyImpact()
public
previewPrivacyImpact(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultpreviewPrivacyImpactAsync()
public
previewPrivacyImpactAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisestartProtectedQuery()
public
startProtectedQuery(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultstartProtectedQueryAsync()
public
startProtectedQueryAsync(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
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
PromiseupdateAnalysisTemplate()
public
updateAnalysisTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateAnalysisTemplateAsync()
public
updateAnalysisTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateCollaboration()
public
updateCollaboration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateCollaborationAsync()
public
updateCollaborationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateConfiguredAudienceModelAssociation()
public
updateConfiguredAudienceModelAssociation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateConfiguredAudienceModelAssociationAsync()
public
updateConfiguredAudienceModelAssociationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateConfiguredTable()
public
updateConfiguredTable(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateConfiguredTableAnalysisRule()
public
updateConfiguredTableAnalysisRule(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateConfiguredTableAnalysisRuleAsync()
public
updateConfiguredTableAnalysisRuleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateConfiguredTableAssociation()
public
updateConfiguredTableAssociation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateConfiguredTableAssociationAsync()
public
updateConfiguredTableAssociationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateConfiguredTableAsync()
public
updateConfiguredTableAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateMembership()
public
updateMembership(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateMembershipAsync()
public
updateMembershipAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdatePrivacyBudgetTemplate()
public
updatePrivacyBudgetTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdatePrivacyBudgetTemplateAsync()
public
updatePrivacyBudgetTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateProtectedQuery()
public
updateProtectedQuery(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateProtectedQueryAsync()
public
updateProtectedQueryAsync(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> = []