Interface AwsClientInterface
Interface that all AWS clients implement
- Aws\Common\Client\AwsClientInterface implements Guzzle\Service\ClientInterface
Direct known implementers
Indirect known implementers
Aws\AutoScaling\AutoScalingClient,
Aws\CloudFormation\CloudFormationClient,
Aws\CloudWatchLogs\CloudWatchLogsClient,
Aws\CodeCommit\CodeCommitClient,
Aws\CodeDeploy\CodeDeployClient,
Aws\CodePipeline\CodePipelineClient,
Aws\CognitoIdentity\CognitoIdentityClient,
Aws\CognitoSync\CognitoSyncClient,
Aws\Common\Client\DefaultClient,
Aws\Common\InstanceMetadata\InstanceMetadataClient,
Aws\ConfigService\ConfigServiceClient,
Aws\DataPipeline\DataPipelineClient,
Aws\CloudFront\CloudFrontClient,
Aws\DeviceFarm\DeviceFarmClient,
Aws\DirectConnect\DirectConnectClient,
Aws\DirectoryService\DirectoryServiceClient,
Aws\DynamoDb\DynamoDbClient,
Aws\DynamoDb_2011_12_05\DynamoDbClient,
Aws\DynamoDbStreams\DynamoDbStreamsClient,
Aws\Ec2\Ec2Client,
Aws\Ecs\EcsClient,
Aws\Efs\EfsClient,
Aws\ElastiCache\ElastiCacheClient,
Aws\CloudFront_2012_05_05\CloudFrontClient,
Aws\ElasticBeanstalk\ElasticBeanstalkClient,
Aws\ElasticFileSystem\ElasticFileSystemClient,
Aws\ElasticLoadBalancing\ElasticLoadBalancingClient,
Aws\ElasticTranscoder\ElasticTranscoderClient,
Aws\Emr\EmrClient,
Aws\Glacier\GlacierClient,
Aws\Iam\IamClient,
Aws\ImportExport\ImportExportClient,
Aws\Kinesis\KinesisClient,
Aws\Kms\KmsClient,
Aws\CloudHsm\CloudHsmClient,
Aws\Lambda\LambdaClient,
Aws\MachineLearning\MachineLearningClient,
Aws\OpsWorks\OpsWorksClient,
Aws\Rds\RdsClient,
Aws\Redshift\RedshiftClient,
Aws\Route53\Route53Client,
Aws\Route53Domains\Route53DomainsClient,
Aws\S3\S3Client,
Aws\Ses\SesClient,
Aws\SimpleDb\SimpleDbClient,
Aws\CloudSearch\CloudSearchClient,
Aws\Sns\SnsClient,
Aws\Sqs\SqsClient,
Aws\Ssm\SsmClient,
Aws\StorageGateway\StorageGatewayClient,
Aws\Sts\StsClient,
Aws\Support\SupportClient,
Aws\Swf\SwfClient,
Aws\WorkSpaces\WorkSpacesClient,
Aws\CloudSearch_2011_02_01\CloudSearchClient,
Aws\CloudSearchDomain\CloudSearchDomainClient,
Aws\CloudTrail\CloudTrailClient,
Aws\CloudWatch\CloudWatchClient
Methods summary
-
publicgetCredentials ( )Returns the AWS credentials associated with the client
-
publicsetCredentials ( Aws\Common\Credentials\CredentialsInterface $credentials )Sets the credentials object associated with the client
-
publicgetSignature ( )Returns the signature implementation used with the client
-
publicgetRegions ( )Get a list of available regions and region data
-
publicgetRegion ( )Get the name of the region to which the client is configured to send requests
-
publicsetRegion ( string $region )Change the region to which the client is configured to send requests
-
publicgetWaiterFactory ( )Get the waiter factory being used by the client
-
publicsetWaiterFactory ( Aws\Common\Waiter\WaiterFactoryInterface $waiterFactory )Set the waiter factory to use with the client
-
publicwaitUntil ( string $waiter, array $input = array() )Wait until a resource is available or an associated waiter returns true
-
publicgetWaiter ( string $waiter, array $input = array() )Get a named waiter object
-
publicgetApiVersion ( )Get the API version of the client (e.g. 2006-03-01)
Methods detail
Returns the AWS credentials associated with the client
Returns
public
Aws\Common\Client\AwsClientInterface
setCredentials( Aws\Common\Credentials\CredentialsInterface $credentials )
Sets the credentials object associated with the client
Parameters
- $credentials
Aws\Common\Credentials\CredentialsInterface
$credentials Credentials object to use
Returns
Returns the signature implementation used with the client
Returns
Get a list of available regions and region data
Returns
arrayGet the name of the region to which the client is configured to send requests
Returns
stringChange the region to which the client is configured to send requests
Parameters
- $region
string
$region Name of the region
Returns
public
Aws\Common\Client\AwsClientInterface
setWaiterFactory( Aws\Common\Waiter\WaiterFactoryInterface $waiterFactory )
Set the waiter factory to use with the client
Parameters
- $waiterFactory
Aws\Common\Waiter\WaiterFactoryInterface
$waiterFactory Factory used to create waiters
Returns
Wait until a resource is available or an associated waiter returns true
Parameters
- $waiter
string
$waiter Name of the waiter- $input
array
$input Values used as input for the underlying operation and to control the waiter
Returns
Get a named waiter object
Parameters
- $waiter
string
$waiter Name of the waiter- $input
array
$input Values used as input for the underlying operation and to control the waiter
Returns
Get the API version of the client (e.g. 2006-03-01)
Returns
stringMethods inherited from Guzzle\Service\ClientInterface
execute(),
getCommand(),
getDescription(),
getIterator(),
setDescription()
Methods inherited from Guzzle\Common\FromConfigInterface
Methods inherited from Guzzle\Common\HasDispatcherInterface
addSubscriber(),
dispatch(),
getAllEvents(),
getEventDispatcher(),
setEventDispatcher()
Methods inherited from Guzzle\Http\ClientInterface
createRequest(),
delete(),
get(),
getBaseUrl(),
getConfig(),
head(),
options(),
patch(),
post(),
put(),
send(),
setBaseUrl(),
setConfig(),
setSslVerification(),
setUserAgent()