Class EfsClient
Client to interact with Amazon Elastic File System
- Guzzle\Common\AbstractHasDispatcher implements Guzzle\Common\HasDispatcherInterface
-
Guzzle\Http\Client
implements
Guzzle\Http\ClientInterface
-
Guzzle\Service\Client
implements
Guzzle\Service\ClientInterface
-
Aws\Common\Client\AbstractClient
implements
Aws\Common\Client\AwsClientInterface
-
Aws\Efs\EfsClient
Methods summary
-
public staticfactory ( array|Collection $config = array() )Factory method to create a new Amazon Elastic File System client using an array of configuration options.
-
publiccreateFileSystem ( array $args = array() )Executes the CreateFileSystem operation.
-
publiccreateMountTarget ( array $args = array() )Executes the CreateMountTarget operation.
-
publiccreateTags ( array $args = array() )Executes the CreateTags operation.
-
publicdeleteFileSystem ( array $args = array() )Executes the DeleteFileSystem operation.
-
publicdeleteMountTarget ( array $args = array() )Executes the DeleteMountTarget operation.
-
publicdeleteTags ( array $args = array() )Executes the DeleteTags operation.
-
publicdescribeFileSystems ( array $args = array() )Executes the DescribeFileSystems operation.
-
publicdescribeMountTargetSecurityGroups ( array $args = array() )Executes the DescribeMountTargetSecurityGroups operation.
-
publicdescribeMountTargets ( array $args = array() )Executes the DescribeMountTargets operation.
-
publicdescribeTags ( array $args = array() )Executes the DescribeTags operation.
-
publicmodifyMountTargetSecurityGroups ( array $args = array() )Executes the ModifyMountTargetSecurityGroups operation.
Methods detail
Factory method to create a new Amazon Elastic File System client using an array of configuration options.
See http://docs.aws.amazon.com/aws-sdk-php/v2/guide/configuration.html#client-configuration-options
Parameters
- $config
array|Guzzle\Common\Collection
$config Client configuration data
Returns
Link
Overrides
Executes the CreateFileSystem operation.
Examples
- Basic formatting example
$result = $client->createFileSystem(array( // CreationToken is required 'CreationToken' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
CreationToken => (string)
-
Returns
Guzzle\Service\Resource\ModelReturns a response Model object
-
OwnerId => (string) -
CreationToken => (string) -
FileSystemId => (string) -
CreationTime => (string) -
LifeCycleState => (string) -
Name => (string) -
NumberOfMountTargets => (int) -
SizeInBytes => (associative-array)-
Value => (int) -
Timestamp => (string)
-
Executes the CreateMountTarget operation.
Examples
- Basic formatting example
$result = $client->createMountTarget(array( // FileSystemId is required 'FileSystemId' => 'string', // SubnetId is required 'SubnetId' => 'string', 'IpAddress' => 'string', 'SecurityGroups' => array('string', ... ), ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
FileSystemId => (string) -
SubnetId => (string) -
IpAddress => (string) -
SecurityGroups => (array<string>)
-
Returns
Guzzle\Service\Resource\ModelReturns a response Model object
-
OwnerId => (string) -
MountTargetId => (string) -
FileSystemId => (string) -
SubnetId => (string) -
LifeCycleState => (string) -
IpAddress => (string) -
NetworkInterfaceId => (string)
Executes the CreateTags operation.
Examples
- Basic formatting example
$result = $client->createTags(array( // FileSystemId is required 'FileSystemId' => 'string', // Tags is required 'Tags' => array( array( // Key is required 'Key' => 'string', // Value is required 'Value' => 'string', ), // ... repeated ), ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
FileSystemId => (string) -
Tags => (array<associative-array>)- (associative-array)
-
Key => (string) -
Value => (string)
-
- (associative-array)
-
Returns
Executes the DeleteFileSystem operation.
Examples
- Basic formatting example
$result = $client->deleteFileSystem(array( // FileSystemId is required 'FileSystemId' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
FileSystemId => (string)
-
Returns
Executes the DeleteMountTarget operation.
Examples
- Basic formatting example
$result = $client->deleteMountTarget(array( // MountTargetId is required 'MountTargetId' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
MountTargetId => (string)
-
Returns
Executes the DeleteTags operation.
Examples
- Basic formatting example
$result = $client->deleteTags(array( // FileSystemId is required 'FileSystemId' => 'string', // TagKeys is required 'TagKeys' => array('string', ... ), ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
FileSystemId => (string) -
TagKeys => (array<string>)
-
Returns
Executes the DescribeFileSystems operation.
Examples
- Basic formatting example
$result = $client->describeFileSystems(array( 'MaxItems' => integer, 'Marker' => 'string', 'CreationToken' => 'string', 'FileSystemId' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
MaxItems => (int) -
Marker => (string) -
CreationToken => (string) -
FileSystemId => (string)
-
Returns
Guzzle\Service\Resource\ModelReturns a response Model object
-
Marker => (string) -
FileSystems => (array<associative-array>)- (associative-array)
-
OwnerId => (string) -
CreationToken => (string) -
FileSystemId => (string) -
CreationTime => (string) -
LifeCycleState => (string) -
Name => (string) -
NumberOfMountTargets => (int) -
SizeInBytes => (associative-array)-
Value => (int) -
Timestamp => (string)
-
-
- (associative-array)
-
NextMarker => (string)
Executes the DescribeMountTargetSecurityGroups operation.
Examples
- Basic formatting example
$result = $client->describeMountTargetSecurityGroups(array( // MountTargetId is required 'MountTargetId' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
MountTargetId => (string)
-
Returns
Executes the DescribeMountTargets operation.
Examples
- Basic formatting example
$result = $client->describeMountTargets(array( 'MaxItems' => integer, 'Marker' => 'string', // FileSystemId is required 'FileSystemId' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
MaxItems => (int) -
Marker => (string) -
FileSystemId => (string)
-
Returns
Guzzle\Service\Resource\ModelReturns a response Model object
-
Marker => (string) -
MountTargets => (array<associative-array>)- (associative-array)
-
OwnerId => (string) -
MountTargetId => (string) -
FileSystemId => (string) -
SubnetId => (string) -
LifeCycleState => (string) -
IpAddress => (string) -
NetworkInterfaceId => (string)
-
- (associative-array)
-
NextMarker => (string)
Executes the DescribeTags operation.
Examples
- Basic formatting example
$result = $client->describeTags(array( 'MaxItems' => integer, 'Marker' => 'string', // FileSystemId is required 'FileSystemId' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
MaxItems => (int) -
Marker => (string) -
FileSystemId => (string)
-
Returns
Guzzle\Service\Resource\ModelReturns a response Model object
-
Marker => (string) -
Tags => (array<associative-array>)- (associative-array)
-
Key => (string) -
Value => (string)
-
- (associative-array)
-
NextMarker => (string)
Executes the ModifyMountTargetSecurityGroups operation.
Examples
- Basic formatting example
$result = $client->modifyMountTargetSecurityGroups(array( // MountTargetId is required 'MountTargetId' => 'string', 'SecurityGroups' => array('string', ... ), ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
MountTargetId => (string) -
SecurityGroups => (array<string>)
-
Returns
Methods inherited from Aws\Common\Client\AbstractClient
__call(),
__construct(),
createRequest(),
getAllEvents(),
getApiVersion(),
getCredentials(),
getRegion(),
getRegions(),
getSignature(),
getWaiter(),
getWaiterFactory(),
send(),
setCredentials(),
setRegion(),
setWaiterFactory(),
waitUntil()
Methods inherited from Guzzle\Service\Client
execute(),
executeMultiple(),
getCommand(),
getCommandFactory(),
getDescription(),
getInflector(),
getIterator(),
getResourceIteratorFactory(),
prepareCommand(),
setCommandFactory(),
setDescription(),
setInflector(),
setResourceIteratorFactory()
Methods inherited from Guzzle\Http\Client
delete(),
expandTemplate(),
extractPharCacert(),
get(),
getBaseUrl(),
getConfig(),
getCurlMulti(),
getDefaultOption(),
getDefaultUserAgent(),
getUriTemplate(),
head(),
initSsl(),
options(),
patch(),
post(),
prepareRequest(),
put(),
sendMultiple(),
setBaseUrl(),
setConfig(),
setCurlMulti(),
setDefaultOption(),
setRequestFactory(),
setSslVerification(),
setUriTemplate(),
setUserAgent()
Methods inherited from Guzzle\Common\AbstractHasDispatcher
addSubscriber(),
dispatch(),
getEventDispatcher(),
setEventDispatcher()
Magic methods summary
Constants summary
string |
LATEST_API_VERSION |
'2015-02-01' |
Constants inherited from Guzzle\Service\Client
Constants inherited from Guzzle\Http\Client
CURL_OPTIONS,
DEFAULT_SELECT_TIMEOUT,
DISABLE_REDIRECTS,
MAX_HANDLES,
REQUEST_OPTIONS,
SSL_CERT_AUTHORITY
Constants inherited from Guzzle\Http\ClientInterface
Properties summary
Properties inherited from Aws\Common\Client\AbstractClient
$aggregator,
$credentials,
$signature,
$waiterFactory
Properties inherited from Guzzle\Service\Client
$commandFactory,
$inflector,
$resourceIteratorFactory,
$serviceDescription
Properties inherited from Guzzle\Http\Client
$defaultHeaders,
$requestFactory,
$userAgent