AWS SDK for PHP 3.x (original) (raw)

LambdaClient extends AwsClient

This client is used to interact with AWS Lambda

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.

2015-03-31

Methods

__call() : mixed

__construct() : mixed

The client constructor accepts the following options:

__sleep() : mixed

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

getConfig() : mixed|null

Get a client configuration value.

getCredentials() : PromiseInterface

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

getDefaultCurlOptionsMiddleware() : callable

Provides a middleware that sets default Curl options for the command

getEndpoint() : UriInterface

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

getEndpointProvider() : mixed

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

Retrieves arguments to be used in endpoint resolution.

getHandlerList() : HandlerList

Get the handler list used to transfer commands.

getIterator() : mixed

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

waitUntil() : mixed

__call()

public __call(mixed <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>n</mi><mi>a</mi><mi>m</mi><mi>e</mi><mo separator="true">,</mo><mi>a</mi><mi>r</mi><mi>r</mi><mi>a</mi><mi>y</mi><mo><</mo><mi>s</mi><mi>t</mi><mi>r</mi><mi>i</mi><mi>n</mi><mi>g</mi><mi mathvariant="normal">∣</mi><mi>i</mi><mi>n</mi><mi>t</mi><mo separator="true">,</mo><mi>m</mi><mi>i</mi><mi>x</mi><mi>e</mi><mi>d</mi><mo>></mo></mrow><annotation encoding="application/x-tex">name, array<string|int, mixed> </annotation></semantics></math>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

Parameters

$args : array<string|int, mixed>

Client configuration arguments.

__sleep()

public __sleep() : mixed

emitDeprecationWarning()

public static emitDeprecationWarning() : mixed

execute()

public execute([CommandInterface](class-Aws.CommandInterface.html) $command) : mixed

Parameters

$command : CommandInterface

executeAsync()

public executeAsync([CommandInterface](class-Aws.CommandInterface.html) $command) : mixed

Parameters

$command : CommandInterface

factory()

public static factory([array<string|int, mixed> $config = [] ]) : static

Parameters

$config : array<string|int, mixed> = []

Return values

static

getApi()

public abstract getApi() : [Service](class-Aws.Api.Service.html)

Return values

Service

getArguments()

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

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

Return values

array<string|int, mixed>

getClientBuiltIns()

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

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

Return values

array<string|int, mixed>

getClientContextParams()

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

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

Return values

array<string|int, mixed>

getCommand()

public abstract getCommand(string <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>n</mi><mi>a</mi><mi>m</mi><mi>e</mi><mo stretchy="false">[</mo><mo separator="true">,</mo><mi>a</mi><mi>r</mi><mi>r</mi><mi>a</mi><mi>y</mi><mo><</mo><mi>s</mi><mi>t</mi><mi>r</mi><mi>i</mi><mi>n</mi><mi>g</mi><mi mathvariant="normal">∣</mi><mi>i</mi><mi>n</mi><mi>t</mi><mo separator="true">,</mo><mi>m</mi><mi>i</mi><mi>x</mi><mi>e</mi><mi>d</mi><mo>></mo></mrow><annotation encoding="application/x-tex">name[, array<string|int, mixed> </annotation></semantics></math>name[,array<string∣int,mixed>args = [] ]) : [CommandInterface](class-Aws.CommandInterface.html)

Parameters

$name : string

$args : array<string|int, mixed> = []

Return values

CommandInterface

getConfig()

Get a client configuration value.

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

Parameters

$option : mixed = null

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

Return values

mixed|null

getCredentials()

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

public getCredentials() : [PromiseInterface](class-GuzzleHttp.Promise.PromiseInterface.html)

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

Return values

PromiseInterface

getDefaultCurlOptionsMiddleware()

Provides a middleware that sets default Curl options for the command

public getDefaultCurlOptionsMiddleware() : callable

Return values

callable

getEndpoint()

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

public getEndpoint() : [UriInterface](class-Psr.Http.Message.UriInterface.html)

Return values

UriInterface

getEndpointProvider()

public getEndpointProvider() : mixed

getEndpointProviderArgs()

Retrieves arguments to be used in endpoint resolution.

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

Return values

array<string|int, mixed>

getHandlerList()

Get the handler list used to transfer commands.

public getHandlerList() : [HandlerList](class-Aws.HandlerList.html)

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 <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>n</mi><mi>a</mi><mi>m</mi><mi>e</mi><mo stretchy="false">[</mo><mo separator="true">,</mo><mi>a</mi><mi>r</mi><mi>r</mi><mi>a</mi><mi>y</mi><mo><</mo><mi>s</mi><mi>t</mi><mi>r</mi><mi>i</mi><mi>n</mi><mi>g</mi><mi mathvariant="normal">∣</mi><mi>i</mi><mi>n</mi><mi>t</mi><mo separator="true">,</mo><mi>m</mi><mi>i</mi><mi>x</mi><mi>e</mi><mi>d</mi><mo>></mo></mrow><annotation encoding="application/x-tex">name[, array<string|int, mixed> </annotation></semantics></math>name[,array<string∣int,mixed>args = [] ]) : mixed

Parameters

$name : mixed

$args : array<string|int, mixed> = []

getPaginator()

public getPaginator(mixed <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>n</mi><mi>a</mi><mi>m</mi><mi>e</mi><mo stretchy="false">[</mo><mo separator="true">,</mo><mi>a</mi><mi>r</mi><mi>r</mi><mi>a</mi><mi>y</mi><mo><</mo><mi>s</mi><mi>t</mi><mi>r</mi><mi>i</mi><mi>n</mi><mi>g</mi><mi mathvariant="normal">∣</mi><mi>i</mi><mi>n</mi><mi>t</mi><mo separator="true">,</mo><mi>m</mi><mi>i</mi><mi>x</mi><mi>e</mi><mi>d</mi><mo>></mo></mrow><annotation encoding="application/x-tex">name[, array<string|int, mixed> </annotation></semantics></math>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

string

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable

Return values

callable

getWaiter()

public getWaiter(mixed <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>n</mi><mi>a</mi><mi>m</mi><mi>e</mi><mo stretchy="false">[</mo><mo separator="true">,</mo><mi>a</mi><mi>r</mi><mi>r</mi><mi>a</mi><mi>y</mi><mo><</mo><mi>s</mi><mi>t</mi><mi>r</mi><mi>i</mi><mi>n</mi><mi>g</mi><mi mathvariant="normal">∣</mi><mi>i</mi><mi>n</mi><mi>t</mi><mo separator="true">,</mo><mi>m</mi><mi>i</mi><mi>x</mi><mi>e</mi><mi>d</mi><mo>></mo></mrow><annotation encoding="application/x-tex">name[, array<string|int, mixed> </annotation></semantics></math>name[,array<string∣int,mixed>args = [] ]) : mixed

Parameters

$name : mixed

$args : array<string|int, mixed> = []

waitUntil()

public waitUntil(mixed <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>n</mi><mi>a</mi><mi>m</mi><mi>e</mi><mo stretchy="false">[</mo><mo separator="true">,</mo><mi>a</mi><mi>r</mi><mi>r</mi><mi>a</mi><mi>y</mi><mo><</mo><mi>s</mi><mi>t</mi><mi>r</mi><mi>i</mi><mi>n</mi><mi>g</mi><mi mathvariant="normal">∣</mi><mi>i</mi><mi>n</mi><mi>t</mi><mo separator="true">,</mo><mi>m</mi><mi>i</mi><mi>x</mi><mi>e</mi><mi>d</mi><mo>></mo></mrow><annotation encoding="application/x-tex">name[, array<string|int, mixed> </annotation></semantics></math>name[,array<string∣int,mixed>args = [] ]) : mixed

Parameters

$name : mixed

$args : array<string|int, mixed> = []

AWS SDK for PHP 3.x (original) (raw)

LambdaClient extends AwsClient

Supported API Versions

Table of Contents

Methods

__call()

Parameters

__construct()

Parameters

__sleep()

emitDeprecationWarning()

execute()

Parameters

executeAsync()

Parameters

factory()

Parameters

Tags

Return values

getApi()

Return values

getArguments()

Return values

getClientBuiltIns()

Return values

getClientContextParams()

Return values

getCommand()

Parameters

Return values

getConfig()

Parameters

Return values

getCredentials()

Return values

getDefaultCurlOptionsMiddleware()

Return values

getEndpoint()

Return values

getEndpointProvider()

getEndpointProviderArgs()

Return values

getHandlerList()

Return values

getIterator()

Parameters

getPaginator()

Parameters

getRegion()

Return values

getSignatureProvider()

Return values

getWaiter()

Parameters

waitUntil()

Parameters