Documentation

ServiceCatalogClient extends AwsClient
in package

This client is used to interact with the **AWS Service Catalog** 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
acceptPortfolioShare()  :
acceptPortfolioShareAsync()  :
associateBudgetWithResource()  :
associateBudgetWithResourceAsync()  :
associatePrincipalWithPortfolio()  :
associatePrincipalWithPortfolioAsync()  :
associateProductWithPortfolio()  :
associateProductWithPortfolioAsync()  :
associateServiceActionWithProvisioningArtifact()  :
associateServiceActionWithProvisioningArtifactAsync()  :
associateTagOptionWithResource()  :
associateTagOptionWithResourceAsync()  :
batchAssociateServiceActionWithProvisioningArtifact()  :
batchAssociateServiceActionWithProvisioningArtifactAsync()  :
batchDisassociateServiceActionFromProvisioningArtifact()  :
batchDisassociateServiceActionFromProvisioningArtifactAsync()  :
copyProduct()  :
copyProductAsync()  :
createConstraint()  :
createConstraintAsync()  :
createPortfolio()  :
createPortfolioAsync()  :
createPortfolioShare()  :
createPortfolioShareAsync()  :
createProduct()  :
createProductAsync()  :
createProvisionedProductPlan()  :
createProvisionedProductPlanAsync()  :
createProvisioningArtifact()  :
createProvisioningArtifactAsync()  :
createServiceAction()  :
createServiceActionAsync()  :
createTagOption()  :
createTagOptionAsync()  :
deleteConstraint()  :
deleteConstraintAsync()  :
deletePortfolio()  :
deletePortfolioAsync()  :
deletePortfolioShare()  :
deletePortfolioShareAsync()  :
deleteProduct()  :
deleteProductAsync()  :
deleteProvisionedProductPlan()  :
deleteProvisionedProductPlanAsync()  :
deleteProvisioningArtifact()  :
deleteProvisioningArtifactAsync()  :
deleteServiceAction()  :
deleteServiceActionAsync()  :
deleteTagOption()  :
deleteTagOptionAsync()  :
describeConstraint()  :
describeConstraintAsync()  :
describeCopyProductStatus()  :
describeCopyProductStatusAsync()  :
describePortfolio()  :
describePortfolioAsync()  :
describePortfolioShares()  :
describePortfolioSharesAsync()  :
describePortfolioShareStatus()  :
describePortfolioShareStatusAsync()  :
describeProduct()  :
describeProductAsAdmin()  :
describeProductAsAdminAsync()  :
describeProductAsync()  :
describeProductView()  :
describeProductViewAsync()  :
describeProvisionedProduct()  :
describeProvisionedProductAsync()  :
describeProvisionedProductPlan()  :
describeProvisionedProductPlanAsync()  :
describeProvisioningArtifact()  :
describeProvisioningArtifactAsync()  :
describeProvisioningParameters()  :
describeProvisioningParametersAsync()  :
describeRecord()  :
describeRecordAsync()  :
describeServiceAction()  :
describeServiceActionAsync()  :
describeServiceActionExecutionParameters()  :
describeServiceActionExecutionParametersAsync()  :
describeTagOption()  :
describeTagOptionAsync()  :
disableAWSOrganizationsAccess()  :
disableAWSOrganizationsAccessAsync()  :
disassociateBudgetFromResource()  :
disassociateBudgetFromResourceAsync()  :
disassociatePrincipalFromPortfolio()  :
disassociatePrincipalFromPortfolioAsync()  :
disassociateProductFromPortfolio()  :
disassociateProductFromPortfolioAsync()  :
disassociateServiceActionFromProvisioningArtifact()  :
disassociateServiceActionFromProvisioningArtifactAsync()  :
disassociateTagOptionFromResource()  :
disassociateTagOptionFromResourceAsync()  :
enableAWSOrganizationsAccess()  :
enableAWSOrganizationsAccessAsync()  :
execute()  : mixed
executeAsync()  : mixed
executeProvisionedProductPlan()  :
executeProvisionedProductPlanAsync()  :
executeProvisionedProductServiceAction()  :
executeProvisionedProductServiceActionAsync()  :
factory()  : static
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getAWSOrganizationsAccessStatus()  :
getAWSOrganizationsAccessStatusAsync()  :
getCommand()  : CommandInterface
getConfig()  : mixed|null
Get a client configuration value.
getCredentials()  : PromiseInterface
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
getEndpoint()  : UriInterface
Gets the default endpoint, or base URL, used by the client.
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getIterator()  : mixed
getPaginator()  : mixed
getProvisionedProductOutputs()  :
getProvisionedProductOutputsAsync()  :
getRegion()  : string
Get the region to which the client is configured to send requests.
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getWaiter()  : mixed
importAsProvisionedProduct()  :
importAsProvisionedProductAsync()  :
listAcceptedPortfolioShares()  :
listAcceptedPortfolioSharesAsync()  :
listBudgetsForResource()  :
listBudgetsForResourceAsync()  :
listConstraintsForPortfolio()  :
listConstraintsForPortfolioAsync()  :
listLaunchPaths()  :
listLaunchPathsAsync()  :
listOrganizationPortfolioAccess()  :
listOrganizationPortfolioAccessAsync()  :
listPortfolioAccess()  :
listPortfolioAccessAsync()  :
listPortfolios()  :
listPortfoliosAsync()  :
listPortfoliosForProduct()  :
listPortfoliosForProductAsync()  :
listPrincipalsForPortfolio()  :
listPrincipalsForPortfolioAsync()  :
listProvisionedProductPlans()  :
listProvisionedProductPlansAsync()  :
listProvisioningArtifacts()  :
listProvisioningArtifactsAsync()  :
listProvisioningArtifactsForServiceAction()  :
listProvisioningArtifactsForServiceActionAsync()  :
listRecordHistory()  :
listRecordHistoryAsync()  :
listResourcesForTagOption()  :
listResourcesForTagOptionAsync()  :
listServiceActions()  :
listServiceActionsAsync()  :
listServiceActionsForProvisioningArtifact()  :
listServiceActionsForProvisioningArtifactAsync()  :
listStackInstancesForProvisionedProduct()  :
listStackInstancesForProvisionedProductAsync()  :
listTagOptions()  :
listTagOptionsAsync()  :
provisionProduct()  :
provisionProductAsync()  :
rejectPortfolioShare()  :
rejectPortfolioShareAsync()  :
scanProvisionedProducts()  :
scanProvisionedProductsAsync()  :
searchProducts()  :
searchProductsAsAdmin()  :
searchProductsAsAdminAsync()  :
searchProductsAsync()  :
searchProvisionedProducts()  :
searchProvisionedProductsAsync()  :
terminateProvisionedProduct()  :
terminateProvisionedProductAsync()  :
updateConstraint()  :
updateConstraintAsync()  :
updatePortfolio()  :
updatePortfolioAsync()  :
updatePortfolioShare()  :
updatePortfolioShareAsync()  :
updateProduct()  :
updateProductAsync()  :
updateProvisionedProduct()  :
updateProvisionedProductAsync()  :
updateProvisionedProductProperties()  :
updateProvisionedProductPropertiesAsync()  :
updateProvisioningArtifact()  :
updateProvisioningArtifactAsync()  :
updateServiceAction()  :
updateServiceActionAsync()  :
updateTagOption()  :
updateTagOptionAsync()  :
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 —

acceptPortfolioShare()

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

acceptPortfolioShareAsync()

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

associateBudgetWithResource()

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

associateBudgetWithResourceAsync()

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

associatePrincipalWithPortfolio()

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

associatePrincipalWithPortfolioAsync()

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

associateProductWithPortfolio()

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

associateProductWithPortfolioAsync()

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

associateServiceActionWithProvisioningArtifact()

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

associateServiceActionWithProvisioningArtifactAsync()

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

associateTagOptionWithResource()

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

associateTagOptionWithResourceAsync()

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

batchAssociateServiceActionWithProvisioningArtifact()

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

batchAssociateServiceActionWithProvisioningArtifactAsync()

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

batchDisassociateServiceActionFromProvisioningArtifact()

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

batchDisassociateServiceActionFromProvisioningArtifactAsync()

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

copyProduct()

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

copyProductAsync()

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

createConstraint()

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

createConstraintAsync()

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

createPortfolio()

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

createPortfolioAsync()

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

createPortfolioShare()

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

createPortfolioShareAsync()

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

createProduct()

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

createProductAsync()

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

createProvisionedProductPlan()

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

createProvisionedProductPlanAsync()

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

createProvisioningArtifact()

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

createProvisioningArtifactAsync()

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

createServiceAction()

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

createServiceActionAsync()

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

createTagOption()

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

createTagOptionAsync()

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

deleteConstraint()

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

deleteConstraintAsync()

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

deletePortfolio()

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

deletePortfolioAsync()

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

deletePortfolioShare()

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

deletePortfolioShareAsync()

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

deleteProduct()

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

deleteProductAsync()

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

deleteProvisionedProductPlan()

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

deleteProvisionedProductPlanAsync()

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

deleteProvisioningArtifact()

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

deleteProvisioningArtifactAsync()

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

deleteServiceAction()

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

deleteServiceActionAsync()

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

deleteTagOption()

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

deleteTagOptionAsync()

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

describeConstraint()

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

describeConstraintAsync()

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

describeCopyProductStatus()

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

describeCopyProductStatusAsync()

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

describePortfolio()

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

describePortfolioAsync()

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

describePortfolioShares()

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

describePortfolioSharesAsync()

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

describePortfolioShareStatus()

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

describePortfolioShareStatusAsync()

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

describeProduct()

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

describeProductAsAdmin()

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

describeProductAsAdminAsync()

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

describeProductAsync()

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

describeProductView()

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

describeProductViewAsync()

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

describeProvisionedProduct()

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

describeProvisionedProductAsync()

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

describeProvisionedProductPlan()

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

describeProvisionedProductPlanAsync()

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

describeProvisioningArtifact()

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

describeProvisioningArtifactAsync()

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

describeProvisioningParameters()

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

describeProvisioningParametersAsync()

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

describeRecord()

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

describeRecordAsync()

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

describeServiceAction()

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

describeServiceActionAsync()

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

describeServiceActionExecutionParameters()

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

describeServiceActionExecutionParametersAsync()

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

describeTagOption()

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

describeTagOptionAsync()

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

disableAWSOrganizationsAccess()

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

disableAWSOrganizationsAccessAsync()

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

disassociateBudgetFromResource()

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

disassociateBudgetFromResourceAsync()

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

disassociatePrincipalFromPortfolio()

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

disassociatePrincipalFromPortfolioAsync()

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

disassociateProductFromPortfolio()

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

disassociateProductFromPortfolioAsync()

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

disassociateServiceActionFromProvisioningArtifact()

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

disassociateServiceActionFromProvisioningArtifactAsync()

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

disassociateTagOptionFromResource()

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

disassociateTagOptionFromResourceAsync()

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

enableAWSOrganizationsAccess()

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

enableAWSOrganizationsAccessAsync()

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

executeProvisionedProductPlan()

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

executeProvisionedProductPlanAsync()

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

executeProvisionedProductServiceAction()

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

executeProvisionedProductServiceActionAsync()

public executeProvisionedProductServiceActionAsync(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> —

getAWSOrganizationsAccessStatus()

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

getAWSOrganizationsAccessStatusAsync()

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

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 —

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 —

getProvisionedProductOutputs()

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

getProvisionedProductOutputsAsync()

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

getRegion()

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

public getRegion() : string
Return values
string —

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable —

getWaiter()

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

importAsProvisionedProduct()

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

importAsProvisionedProductAsync()

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

listAcceptedPortfolioShares()

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

listAcceptedPortfolioSharesAsync()

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

listBudgetsForResource()

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

listBudgetsForResourceAsync()

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

listConstraintsForPortfolio()

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

listConstraintsForPortfolioAsync()

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

listLaunchPaths()

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

listLaunchPathsAsync()

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

listOrganizationPortfolioAccess()

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

listOrganizationPortfolioAccessAsync()

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

listPortfolioAccess()

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

listPortfolioAccessAsync()

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

listPortfolios()

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

listPortfoliosAsync()

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

listPortfoliosForProduct()

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

listPortfoliosForProductAsync()

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

listPrincipalsForPortfolio()

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

listPrincipalsForPortfolioAsync()

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

listProvisionedProductPlans()

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

listProvisionedProductPlansAsync()

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

listProvisioningArtifacts()

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

listProvisioningArtifactsAsync()

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

listProvisioningArtifactsForServiceAction()

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

listProvisioningArtifactsForServiceActionAsync()

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

listRecordHistory()

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

listRecordHistoryAsync()

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

listResourcesForTagOption()

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

listResourcesForTagOptionAsync()

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

listServiceActions()

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

listServiceActionsAsync()

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

listServiceActionsForProvisioningArtifact()

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

listServiceActionsForProvisioningArtifactAsync()

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

listStackInstancesForProvisionedProduct()

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

listStackInstancesForProvisionedProductAsync()

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

listTagOptions()

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

listTagOptionsAsync()

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

provisionProduct()

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

provisionProductAsync()

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

rejectPortfolioShare()

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

rejectPortfolioShareAsync()

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

scanProvisionedProducts()

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

scanProvisionedProductsAsync()

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

searchProducts()

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

searchProductsAsAdmin()

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

searchProductsAsAdminAsync()

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

searchProductsAsync()

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

searchProvisionedProducts()

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

searchProvisionedProductsAsync()

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

terminateProvisionedProduct()

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

terminateProvisionedProductAsync()

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

updateConstraint()

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

updateConstraintAsync()

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

updatePortfolio()

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

updatePortfolioAsync()

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

updatePortfolioShare()

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

updatePortfolioShareAsync()

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

updateProduct()

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

updateProductAsync()

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

updateProvisionedProduct()

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

updateProvisionedProductAsync()

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

updateProvisionedProductProperties()

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

updateProvisionedProductPropertiesAsync()

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

updateProvisioningArtifact()

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

updateProvisioningArtifactAsync()

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

updateServiceAction()

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

updateServiceActionAsync()

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

updateTagOption()

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

updateTagOptionAsync()

public updateTagOptionAsync(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