Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

SDK for PHP 3.x

Command
in package
implements CommandInterface Uses HasDataTrait

AWS command object.

Table of Contents

Interfaces

CommandInterface
A command object encapsulates the input parameters used to control the creation of a HTTP request and processing of a HTTP response.

Methods

__clone()  : mixed
__construct()  : mixed
Accepts an associative array of command options, including:
count()  : int
get()  : mixed
getAuthSchemes()  : mixed
Get auth schemes added to command as required for endpoint resolution
getHandlerList()  : HandlerList
Get the handler list used to transfer the command.
getIterator()  : Traversable
getName()  : string
Get the name of the command
hasParam()  : bool
Check if the command has a parameter by name.
offsetExists()  : bool
offsetGet()  : mixed|null
This method returns a reference to the variable to allow for indirect array modification (e.g., $foo['bar']['baz'] = 'qux').
offsetSet()  : void
offsetUnset()  : void
toArray()  : mixed

Methods

__clone()

public __clone() : mixed

__construct()

Accepts an associative array of command options, including:

public __construct(string $name[, array<string|int, mixed> $args = [] ][, HandlerList $list = null ][, MetricsBuilder|null $metricsBuilder = null ]) : mixed
  • @http: (array) Associative array of transfer options.
Parameters
$name : string

Name of the command

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

Arguments to pass to the command

$list : HandlerList = null

Handler list

$metricsBuilder : MetricsBuilder|null = null

count()

public count() : int
Return values
int

get()

public get(mixed $name) : mixed
Parameters
$name : mixed
Tags
deprecated

getAuthSchemes()

Get auth schemes added to command as required for endpoint resolution

public getAuthSchemes() : mixed
Tags
returns

array

deprecated

In favor of using the @context property bag. Auth schemes are now accessible via the signature_version key in a Command's context, if applicable.

getHandlerList()

Get the handler list used to transfer the command.

public getHandlerList() : HandlerList
Return values
HandlerList

getIterator()

public getIterator() : Traversable
Return values
Traversable

getName()

Get the name of the command

public getName() : string
Return values
string

hasParam()

Check if the command has a parameter by name.

public hasParam(mixed $name) : bool
Parameters
$name : mixed

Name of the parameter to check

Return values
bool

offsetExists()

public offsetExists(mixed $offset) : bool
Parameters
$offset : mixed
Return values
bool

offsetGet()

This method returns a reference to the variable to allow for indirect array modification (e.g., $foo['bar']['baz'] = 'qux').

public & offsetGet( $offset) : mixed|null
Parameters
$offset :
Return values
mixed|null

offsetSet()

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed
$value : mixed

offsetUnset()

public offsetUnset(mixed $offset) : void
Parameters
$offset : mixed

toArray()

public toArray() : mixed
On this page