imagebuilderClient
extends AwsClient
in package
This client is used to interact with the EC2 Image Builder 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.
- CancelImageCreation
- CancelLifecycleExecution
- CreateComponent
- CreateContainerRecipe
- CreateDistributionConfiguration
- CreateImage
- CreateImagePipeline
- CreateImageRecipe
- CreateInfrastructureConfiguration
- CreateLifecyclePolicy
- CreateWorkflow
- DeleteComponent
- DeleteContainerRecipe
- DeleteDistributionConfiguration
- DeleteImage
- DeleteImagePipeline
- DeleteImageRecipe
- DeleteInfrastructureConfiguration
- DeleteLifecyclePolicy
- DeleteWorkflow
- GetComponent
- GetComponentPolicy
- GetContainerRecipe
- GetContainerRecipePolicy
- GetDistributionConfiguration
- GetImage
- GetImagePipeline
- GetImagePolicy
- GetImageRecipe
- GetImageRecipePolicy
- GetInfrastructureConfiguration
- GetLifecycleExecution
- GetLifecyclePolicy
- GetWorkflow
- GetWorkflowExecution
- GetWorkflowStepExecution
- ImportComponent
- ImportVmImage
- ListComponentBuildVersions
- ListComponents
- ListContainerRecipes
- ListDistributionConfigurations
- ListImageBuildVersions
- ListImagePackages
- ListImagePipelineImages
- ListImagePipelines
- ListImageRecipes
- ListImageScanFindingAggregations
- ListImageScanFindings
- ListImages
- ListInfrastructureConfigurations
- ListLifecycleExecutionResources
- ListLifecycleExecutions
- ListLifecyclePolicies
- ListTagsForResource
- ListWaitingWorkflowSteps
- ListWorkflowBuildVersions
- ListWorkflowExecutions
- ListWorkflowStepExecutions
- ListWorkflows
- PutComponentPolicy
- PutContainerRecipePolicy
- PutImagePolicy
- PutImageRecipePolicy
- SendWorkflowStepAction
- StartImagePipelineExecution
- StartResourceStateUpdate
- TagResource
- UntagResource
- UpdateDistributionConfiguration
- UpdateImagePipeline
- UpdateInfrastructureConfiguration
- UpdateLifecyclePolicy
Table of Contents
Methods
- __call() : mixed
- __construct() : mixed
- The client constructor accepts the following options:
- __sleep() : mixed
- cancelImageCreation() : Result
- cancelImageCreationAsync() : Promise
- cancelLifecycleExecution() : Result
- cancelLifecycleExecutionAsync() : Promise
- createComponent() : Result
- createComponentAsync() : Promise
- createContainerRecipe() : Result
- createContainerRecipeAsync() : Promise
- createDistributionConfiguration() : Result
- createDistributionConfigurationAsync() : Promise
- createImage() : Result
- createImageAsync() : Promise
- createImagePipeline() : Result
- createImagePipelineAsync() : Promise
- createImageRecipe() : Result
- createImageRecipeAsync() : Promise
- createInfrastructureConfiguration() : Result
- createInfrastructureConfigurationAsync() : Promise
- createLifecyclePolicy() : Result
- createLifecyclePolicyAsync() : Promise
- createWorkflow() : Result
- createWorkflowAsync() : Promise
- deleteComponent() : Result
- deleteComponentAsync() : Promise
- deleteContainerRecipe() : Result
- deleteContainerRecipeAsync() : Promise
- deleteDistributionConfiguration() : Result
- deleteDistributionConfigurationAsync() : Promise
- deleteImage() : Result
- deleteImageAsync() : Promise
- deleteImagePipeline() : Result
- deleteImagePipelineAsync() : Promise
- deleteImageRecipe() : Result
- deleteImageRecipeAsync() : Promise
- deleteInfrastructureConfiguration() : Result
- deleteInfrastructureConfigurationAsync() : Promise
- deleteLifecyclePolicy() : Result
- deleteLifecyclePolicyAsync() : Promise
- deleteWorkflow() : Result
- deleteWorkflowAsync() : Promise
- emitDeprecationWarning() : mixed
- execute() : mixed
- executeAsync() : mixed
- factory() : static
- 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.
- getCommand() : CommandInterface
- getComponent() : Result
- getComponentAsync() : Promise
- getComponentPolicy() : Result
- getComponentPolicyAsync() : Promise
- getConfig() : mixed|null
- Get a client configuration value.
- getContainerRecipe() : Result
- getContainerRecipeAsync() : Promise
- getContainerRecipePolicy() : Result
- getContainerRecipePolicyAsync() : Promise
- getCredentials() : PromiseInterface
- Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
- getDistributionConfiguration() : Result
- getDistributionConfigurationAsync() : Promise
- getEndpoint() : UriInterface
- Gets the default endpoint, or base URL, used by the client.
- getEndpointProvider() : mixed
- getEndpointProviderArgs() : array<string|int, mixed>
- Retrieves arguments to be used in endpoint resolution.
- getHandlerList() : HandlerList
- Get the handler list used to transfer commands.
- getImage() : Result
- getImageAsync() : Promise
- getImagePipeline() : Result
- getImagePipelineAsync() : Promise
- getImagePolicy() : Result
- getImagePolicyAsync() : Promise
- getImageRecipe() : Result
- getImageRecipeAsync() : Promise
- getImageRecipePolicy() : Result
- getImageRecipePolicyAsync() : Promise
- getInfrastructureConfiguration() : Result
- getInfrastructureConfigurationAsync() : Promise
- getIterator() : mixed
- getLifecycleExecution() : Result
- getLifecycleExecutionAsync() : Promise
- getLifecyclePolicy() : Result
- getLifecyclePolicyAsync() : Promise
- getPaginator() : mixed
- 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
- getWorkflow() : Result
- getWorkflowAsync() : Promise
- getWorkflowExecution() : Result
- getWorkflowExecutionAsync() : Promise
- getWorkflowStepExecution() : Result
- getWorkflowStepExecutionAsync() : Promise
- importComponent() : Result
- importComponentAsync() : Promise
- importVmImage() : Result
- importVmImageAsync() : Promise
- listComponentBuildVersions() : Result
- listComponentBuildVersionsAsync() : Promise
- listComponents() : Result
- listComponentsAsync() : Promise
- listContainerRecipes() : Result
- listContainerRecipesAsync() : Promise
- listDistributionConfigurations() : Result
- listDistributionConfigurationsAsync() : Promise
- listImageBuildVersions() : Result
- listImageBuildVersionsAsync() : Promise
- listImagePackages() : Result
- listImagePackagesAsync() : Promise
- listImagePipelineImages() : Result
- listImagePipelineImagesAsync() : Promise
- listImagePipelines() : Result
- listImagePipelinesAsync() : Promise
- listImageRecipes() : Result
- listImageRecipesAsync() : Promise
- listImages() : Result
- listImagesAsync() : Promise
- listImageScanFindingAggregations() : Result
- listImageScanFindingAggregationsAsync() : Promise
- listImageScanFindings() : Result
- listImageScanFindingsAsync() : Promise
- listInfrastructureConfigurations() : Result
- listInfrastructureConfigurationsAsync() : Promise
- listLifecycleExecutionResources() : Result
- listLifecycleExecutionResourcesAsync() : Promise
- listLifecycleExecutions() : Result
- listLifecycleExecutionsAsync() : Promise
- listLifecyclePolicies() : Result
- listLifecyclePoliciesAsync() : Promise
- listTagsForResource() : Result
- listTagsForResourceAsync() : Promise
- listWaitingWorkflowSteps() : Result
- listWaitingWorkflowStepsAsync() : Promise
- listWorkflowBuildVersions() : Result
- listWorkflowBuildVersionsAsync() : Promise
- listWorkflowExecutions() : Result
- listWorkflowExecutionsAsync() : Promise
- listWorkflows() : Result
- listWorkflowsAsync() : Promise
- listWorkflowStepExecutions() : Result
- listWorkflowStepExecutionsAsync() : Promise
- putComponentPolicy() : Result
- putComponentPolicyAsync() : Promise
- putContainerRecipePolicy() : Result
- putContainerRecipePolicyAsync() : Promise
- putImagePolicy() : Result
- putImagePolicyAsync() : Promise
- putImageRecipePolicy() : Result
- putImageRecipePolicyAsync() : Promise
- sendWorkflowStepAction() : Result
- sendWorkflowStepActionAsync() : Promise
- startImagePipelineExecution() : Result
- startImagePipelineExecutionAsync() : Promise
- startResourceStateUpdate() : Result
- startResourceStateUpdateAsync() : Promise
- tagResource() : Result
- tagResourceAsync() : Promise
- untagResource() : Result
- untagResourceAsync() : Promise
- updateDistributionConfiguration() : Result
- updateDistributionConfigurationAsync() : Promise
- updateImagePipeline() : Result
- updateImagePipelineAsync() : Promise
- updateInfrastructureConfiguration() : Result
- updateInfrastructureConfigurationAsync() : Promise
- updateLifecyclePolicy() : Result
- updateLifecyclePolicyAsync() : 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
cancelImageCreation()
public
cancelImageCreation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcancelImageCreationAsync()
public
cancelImageCreationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecancelLifecycleExecution()
public
cancelLifecycleExecution(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcancelLifecycleExecutionAsync()
public
cancelLifecycleExecutionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateComponent()
public
createComponent(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateComponentAsync()
public
createComponentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateContainerRecipe()
public
createContainerRecipe(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateContainerRecipeAsync()
public
createContainerRecipeAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateDistributionConfiguration()
public
createDistributionConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateDistributionConfigurationAsync()
public
createDistributionConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateImage()
public
createImage(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateImageAsync()
public
createImageAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateImagePipeline()
public
createImagePipeline(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateImagePipelineAsync()
public
createImagePipelineAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateImageRecipe()
public
createImageRecipe(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateImageRecipeAsync()
public
createImageRecipeAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateInfrastructureConfiguration()
public
createInfrastructureConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateInfrastructureConfigurationAsync()
public
createInfrastructureConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateLifecyclePolicy()
public
createLifecyclePolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateLifecyclePolicyAsync()
public
createLifecyclePolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateWorkflow()
public
createWorkflow(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateWorkflowAsync()
public
createWorkflowAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteComponent()
public
deleteComponent(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteComponentAsync()
public
deleteComponentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteContainerRecipe()
public
deleteContainerRecipe(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteContainerRecipeAsync()
public
deleteContainerRecipeAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteDistributionConfiguration()
public
deleteDistributionConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteDistributionConfigurationAsync()
public
deleteDistributionConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteImage()
public
deleteImage(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteImageAsync()
public
deleteImageAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteImagePipeline()
public
deleteImagePipeline(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteImagePipelineAsync()
public
deleteImagePipelineAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteImageRecipe()
public
deleteImageRecipe(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteImageRecipeAsync()
public
deleteImageRecipeAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteInfrastructureConfiguration()
public
deleteInfrastructureConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteInfrastructureConfigurationAsync()
public
deleteInfrastructureConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteLifecyclePolicy()
public
deleteLifecyclePolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteLifecyclePolicyAsync()
public
deleteLifecyclePolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteWorkflow()
public
deleteWorkflow(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteWorkflowAsync()
public
deleteWorkflowAsync(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
staticgetApi()
public
abstract getApi() : Service
Return values
ServicegetArguments()
Get an array of client constructor arguments used by the client.
public
static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed>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>getCommand()
public
abstract getCommand(string $name[, array<string|int, mixed> $args = [] ]) : CommandInterface
Parameters
- $name : string
- $args : array<string|int, mixed> = []
Return values
CommandInterfacegetComponent()
public
getComponent(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetComponentAsync()
public
getComponentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetComponentPolicy()
public
getComponentPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetComponentPolicyAsync()
public
getComponentPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetConfig()
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|nullgetContainerRecipe()
public
getContainerRecipe(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetContainerRecipeAsync()
public
getContainerRecipeAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetContainerRecipePolicy()
public
getContainerRecipePolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetContainerRecipePolicyAsync()
public
getContainerRecipePolicyAsync(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
PromiseInterfacegetDistributionConfiguration()
public
getDistributionConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetDistributionConfigurationAsync()
public
getDistributionConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetEndpoint()
Gets the default endpoint, or base URL, used by the client.
public
getEndpoint() : UriInterface
Return values
UriInterfacegetEndpointProvider()
public
getEndpointProvider() : mixed
getEndpointProviderArgs()
Retrieves arguments to be used in endpoint resolution.
public
getEndpointProviderArgs() : array<string|int, mixed>
Return values
array<string|int, mixed>getHandlerList()
Get the handler list used to transfer commands.
public
getHandlerList() : HandlerList
This list can be modified to add middleware or to change the underlying handler used to send HTTP requests.
Return values
HandlerListgetImage()
public
getImage(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetImageAsync()
public
getImageAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetImagePipeline()
public
getImagePipeline(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetImagePipelineAsync()
public
getImagePipelineAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetImagePolicy()
public
getImagePolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetImagePolicyAsync()
public
getImagePolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetImageRecipe()
public
getImageRecipe(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetImageRecipeAsync()
public
getImageRecipeAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetImageRecipePolicy()
public
getImageRecipePolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetImageRecipePolicyAsync()
public
getImageRecipePolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetInfrastructureConfiguration()
public
getInfrastructureConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetInfrastructureConfigurationAsync()
public
getInfrastructureConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetIterator()
public
getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
getLifecycleExecution()
public
getLifecycleExecution(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetLifecycleExecutionAsync()
public
getLifecycleExecutionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetLifecyclePolicy()
public
getLifecyclePolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetLifecyclePolicyAsync()
public
getLifecyclePolicyAsync(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> = []
getRegion()
Get the region to which the client is configured to send requests.
public
getRegion() : string
Return values
stringgetSignatureProvider()
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> = []
getWorkflow()
public
getWorkflow(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetWorkflowAsync()
public
getWorkflowAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetWorkflowExecution()
public
getWorkflowExecution(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetWorkflowExecutionAsync()
public
getWorkflowExecutionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetWorkflowStepExecution()
public
getWorkflowStepExecution(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetWorkflowStepExecutionAsync()
public
getWorkflowStepExecutionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseimportComponent()
public
importComponent(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultimportComponentAsync()
public
importComponentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseimportVmImage()
public
importVmImage(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultimportVmImageAsync()
public
importVmImageAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistComponentBuildVersions()
public
listComponentBuildVersions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistComponentBuildVersionsAsync()
public
listComponentBuildVersionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistComponents()
public
listComponents(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistComponentsAsync()
public
listComponentsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistContainerRecipes()
public
listContainerRecipes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistContainerRecipesAsync()
public
listContainerRecipesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistDistributionConfigurations()
public
listDistributionConfigurations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistDistributionConfigurationsAsync()
public
listDistributionConfigurationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistImageBuildVersions()
public
listImageBuildVersions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistImageBuildVersionsAsync()
public
listImageBuildVersionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistImagePackages()
public
listImagePackages(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistImagePackagesAsync()
public
listImagePackagesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistImagePipelineImages()
public
listImagePipelineImages(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistImagePipelineImagesAsync()
public
listImagePipelineImagesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistImagePipelines()
public
listImagePipelines(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistImagePipelinesAsync()
public
listImagePipelinesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistImageRecipes()
public
listImageRecipes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistImageRecipesAsync()
public
listImageRecipesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistImages()
public
listImages(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistImagesAsync()
public
listImagesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistImageScanFindingAggregations()
public
listImageScanFindingAggregations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistImageScanFindingAggregationsAsync()
public
listImageScanFindingAggregationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistImageScanFindings()
public
listImageScanFindings(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistImageScanFindingsAsync()
public
listImageScanFindingsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistInfrastructureConfigurations()
public
listInfrastructureConfigurations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistInfrastructureConfigurationsAsync()
public
listInfrastructureConfigurationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistLifecycleExecutionResources()
public
listLifecycleExecutionResources(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistLifecycleExecutionResourcesAsync()
public
listLifecycleExecutionResourcesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistLifecycleExecutions()
public
listLifecycleExecutions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistLifecycleExecutionsAsync()
public
listLifecycleExecutionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistLifecyclePolicies()
public
listLifecyclePolicies(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistLifecyclePoliciesAsync()
public
listLifecyclePoliciesAsync(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
PromiselistWaitingWorkflowSteps()
public
listWaitingWorkflowSteps(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistWaitingWorkflowStepsAsync()
public
listWaitingWorkflowStepsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistWorkflowBuildVersions()
public
listWorkflowBuildVersions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistWorkflowBuildVersionsAsync()
public
listWorkflowBuildVersionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistWorkflowExecutions()
public
listWorkflowExecutions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistWorkflowExecutionsAsync()
public
listWorkflowExecutionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistWorkflows()
public
listWorkflows(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistWorkflowsAsync()
public
listWorkflowsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistWorkflowStepExecutions()
public
listWorkflowStepExecutions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistWorkflowStepExecutionsAsync()
public
listWorkflowStepExecutionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputComponentPolicy()
public
putComponentPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputComponentPolicyAsync()
public
putComponentPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputContainerRecipePolicy()
public
putContainerRecipePolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputContainerRecipePolicyAsync()
public
putContainerRecipePolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputImagePolicy()
public
putImagePolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputImagePolicyAsync()
public
putImagePolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputImageRecipePolicy()
public
putImageRecipePolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputImageRecipePolicyAsync()
public
putImageRecipePolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesendWorkflowStepAction()
public
sendWorkflowStepAction(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsendWorkflowStepActionAsync()
public
sendWorkflowStepActionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisestartImagePipelineExecution()
public
startImagePipelineExecution(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultstartImagePipelineExecutionAsync()
public
startImagePipelineExecutionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisestartResourceStateUpdate()
public
startResourceStateUpdate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultstartResourceStateUpdateAsync()
public
startResourceStateUpdateAsync(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
PromiseupdateDistributionConfiguration()
public
updateDistributionConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateDistributionConfigurationAsync()
public
updateDistributionConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateImagePipeline()
public
updateImagePipeline(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateImagePipelineAsync()
public
updateImagePipelineAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateInfrastructureConfiguration()
public
updateInfrastructureConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateInfrastructureConfigurationAsync()
public
updateInfrastructureConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateLifecyclePolicy()
public
updateLifecyclePolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateLifecyclePolicyAsync()
public
updateLifecyclePolicyAsync(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> = []