Interface ResultInterface
- Aws\ResultInterface implements ArrayAccess, IteratorAggregate, Countable
- Namespace: Aws
- Located at ResultInterface.php
Represents an AWS result object that is returned from executing an operation.
Direct known implementers
Methods Summary
-
__toString ( )
Provides debug information about the result object
-
toArray ( )
Convert the result to an array.
-
hasKey ( string $name )
Check if the model contains a key by name
-
get ( string $key )
Get a specific key value from the result model.
-
search ( string $expression )
Returns the result of executing a JMESPath expression on the contents of the Result model.
Methods inherited from ArrayAccess
offsetExists()
,
offsetGet()
,
offsetSet()
,
offsetUnset()
Methods inherited from IteratorAggregate
getIterator()
Methods inherited from Countable
count()
Methods Details
string __toString ( )
Provides debug information about the result object
Returns
string |
array toArray ( )
Convert the result to an array.
Returns
array |
boolean hasKey ( string $name )
Check if the model contains a key by name
Parameters
string | $name | Name of the key to retrieve |
Returns
boolean |
mixed|null get ( string $key )
Get a specific key value from the result model.
Parameters
string | $key | Key to retrieve. |
Returns
mixed|null Value of the key or NULL if not found. |
mixed search ( string $expression )
Returns the result of executing a JMESPath expression on the contents of the Result model.
$result = $client->execute($command); $jpResult = $result->search('foo.*.bar[?baz > 10
]');
Parameters
string | $expression | JMESPath expression to execute |
Returns
mixed Returns the result of the JMESPath expression. |