Interface AwsClientInterface
Represents an AWS client.
Direct known implementers
Aws\AwsClient,
Aws\MultiRegionClient,
Aws\S3\S3ClientInterface
Indirect known implementers
Aws\AccessAnalyzer\AccessAnalyzerClient,
Aws\Account\AccountClient,
Aws\ApiGatewayV2\ApiGatewayV2Client,
Aws\DocDBElastic\DocDBElasticClient,
Aws\drs\drsClient,
Aws\DynamoDb\DynamoDbClient,
Aws\DynamoDbStreams\DynamoDbStreamsClient,
Aws\EBS\EBSClient,
Aws\Ec2\Ec2Client,
Aws\EC2InstanceConnect\EC2InstanceConnectClient,
Aws\Ecr\EcrClient,
Aws\ECRPublic\ECRPublicClient,
Aws\Ecs\EcsClient,
Aws\AppConfig\AppConfigClient,
Aws\Efs\EfsClient,
Aws\EKS\EKSClient,
Aws\ElastiCache\ElastiCacheClient,
Aws\ElasticBeanstalk\ElasticBeanstalkClient,
Aws\ElasticInference\ElasticInferenceClient,
Aws\ElasticLoadBalancing\ElasticLoadBalancingClient,
Aws\ElasticLoadBalancingV2\ElasticLoadBalancingV2Client,
Aws\ElasticsearchService\ElasticsearchServiceClient,
Aws\ElasticTranscoder\ElasticTranscoderClient,
Aws\Emr\EmrClient,
Aws\AppConfigData\AppConfigDataClient,
Aws\EMRContainers\EMRContainersClient,
Aws\EMRServerless\EMRServerlessClient,
Aws\EventBridge\EventBridgeClient,
Aws\finspace\finspaceClient,
Aws\FinSpaceData\FinSpaceDataClient,
Aws\Firehose\FirehoseClient,
Aws\FIS\FISClient,
Aws\FMS\FMSClient,
Aws\ForecastQueryService\ForecastQueryServiceClient,
Aws\ForecastService\ForecastServiceClient,
Aws\Appflow\AppflowClient,
Aws\FraudDetector\FraudDetectorClient,
Aws\FSx\FSxClient,
Aws\GameLift\GameLiftClient,
Aws\GameSparks\GameSparksClient,
Aws\Glacier\GlacierClient,
Aws\GlobalAccelerator\GlobalAcceleratorClient,
Aws\Glue\GlueClient,
Aws\GlueDataBrew\GlueDataBrewClient,
Aws\Greengrass\GreengrassClient,
Aws\GreengrassV2\GreengrassV2Client,
Aws\AppIntegrationsService\AppIntegrationsServiceClient,
Aws\GroundStation\GroundStationClient,
Aws\GuardDuty\GuardDutyClient,
Aws\Health\HealthClient,
Aws\HealthLake\HealthLakeClient,
Aws\Honeycode\HoneycodeClient,
Aws\Iam\IamClient,
Aws\IdentityStore\IdentityStoreClient,
Aws\imagebuilder\imagebuilderClient,
Aws\ImportExport\ImportExportClient,
Aws\Inspector2\Inspector2Client,
Aws\ApplicationAutoScaling\ApplicationAutoScalingClient,
Aws\Inspector\InspectorClient,
Aws\IoT1ClickDevicesService\IoT1ClickDevicesServiceClient,
Aws\IoT1ClickProjects\IoT1ClickProjectsClient,
Aws\Iot\IotClient,
Aws\IoTAnalytics\IoTAnalyticsClient,
Aws\IotDataPlane\IotDataPlaneClient,
Aws\IoTDeviceAdvisor\IoTDeviceAdvisorClient,
Aws\IoTEvents\IoTEventsClient,
Aws\IoTEventsData\IoTEventsDataClient,
Aws\IoTFleetHub\IoTFleetHubClient,
Aws\ApplicationCostProfiler\ApplicationCostProfilerClient,
Aws\IoTFleetWise\IoTFleetWiseClient,
Aws\IoTJobsDataPlane\IoTJobsDataPlaneClient,
Aws\IoTRoboRunner\IoTRoboRunnerClient,
Aws\IoTSecureTunneling\IoTSecureTunnelingClient,
Aws\IoTSiteWise\IoTSiteWiseClient,
Aws\IoTThingsGraph\IoTThingsGraphClient,
Aws\IoTTwinMaker\IoTTwinMakerClient,
Aws\IoTWireless\IoTWirelessClient,
Aws\IVS\IVSClient,
Aws\ivschat\ivschatClient,
Aws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient,
Aws\Kafka\KafkaClient,
Aws\KafkaConnect\KafkaConnectClient,
Aws\kendra\kendraClient,
Aws\KendraRanking\KendraRankingClient,
Aws\Keyspaces\KeyspacesClient,
Aws\Kinesis\KinesisClient,
Aws\KinesisAnalytics\KinesisAnalyticsClient,
Aws\KinesisAnalyticsV2\KinesisAnalyticsV2Client,
Aws\KinesisVideo\KinesisVideoClient,
Aws\KinesisVideoArchivedMedia\KinesisVideoArchivedMediaClient,
Aws\ApplicationInsights\ApplicationInsightsClient,
Aws\KinesisVideoMedia\KinesisVideoMediaClient,
Aws\KinesisVideoSignalingChannels\KinesisVideoSignalingChannelsClient,
Aws\KinesisVideoWebRTCStorage\KinesisVideoWebRTCStorageClient,
Aws\Kms\KmsClient,
Aws\LakeFormation\LakeFormationClient,
Aws\Lambda\LambdaClient,
Aws\LexModelBuildingService\LexModelBuildingServiceClient,
Aws\LexModelsV2\LexModelsV2Client,
Aws\LexRuntimeService\LexRuntimeServiceClient,
Aws\LexRuntimeV2\LexRuntimeV2Client,
Aws\AppMesh\AppMeshClient,
Aws\LicenseManager\LicenseManagerClient,
Aws\LicenseManagerLinuxSubscriptions\LicenseManagerLinuxSubscriptionsClient,
Aws\LicenseManagerUserSubscriptions\LicenseManagerUserSubscriptionsClient,
Aws\Lightsail\LightsailClient,
Aws\LocationService\LocationServiceClient,
Aws\LookoutEquipment\LookoutEquipmentClient,
Aws\LookoutforVision\LookoutforVisionClient,
Aws\LookoutMetrics\LookoutMetricsClient,
Aws\MachineLearning\MachineLearningClient,
Aws\Macie2\Macie2Client,
Aws\Acm\AcmClient,
Aws\AppRegistry\AppRegistryClient,
Aws\Macie\MacieClient,
Aws\MainframeModernization\MainframeModernizationClient,
Aws\ManagedBlockchain\ManagedBlockchainClient,
Aws\ManagedGrafana\ManagedGrafanaClient,
Aws\MarketplaceCatalog\MarketplaceCatalogClient,
Aws\MarketplaceCommerceAnalytics\MarketplaceCommerceAnalyticsClient,
Aws\MarketplaceEntitlementService\MarketplaceEntitlementServiceClient,
Aws\MarketplaceMetering\MarketplaceMeteringClient,
Aws\MediaConnect\MediaConnectClient,
Aws\MediaConvert\MediaConvertClient,
Aws\AppRunner\AppRunnerClient,
Aws\MediaLive\MediaLiveClient,
Aws\MediaPackage\MediaPackageClient,
Aws\MediaPackageVod\MediaPackageVodClient,
Aws\MediaStore\MediaStoreClient,
Aws\MediaStoreData\MediaStoreDataClient,
Aws\MediaTailor\MediaTailorClient,
Aws\MemoryDB\MemoryDBClient,
Aws\mgn\mgnClient,
Aws\MigrationHub\MigrationHubClient,
Aws\MigrationHubConfig\MigrationHubConfigClient,
Aws\Appstream\AppstreamClient,
Aws\MigrationHubOrchestrator\MigrationHubOrchestratorClient,
Aws\MigrationHubRefactorSpaces\MigrationHubRefactorSpacesClient,
Aws\MigrationHubStrategyRecommendations\MigrationHubStrategyRecommendationsClient,
Aws\Mobile\MobileClient,
Aws\MQ\MQClient,
Aws\MTurk\MTurkClient,
Aws\MWAA\MWAAClient,
Aws\Neptune\NeptuneClient,
Aws\NetworkFirewall\NetworkFirewallClient,
Aws\NetworkManager\NetworkManagerClient,
Aws\AppSync\AppSyncClient,
Aws\NimbleStudio\NimbleStudioClient,
Aws\OAM\OAMClient,
Aws\Omics\OmicsClient,
Aws\OpenSearchServerless\OpenSearchServerlessClient,
Aws\OpenSearchService\OpenSearchServiceClient,
Aws\OpsWorks\OpsWorksClient,
Aws\OpsWorksCM\OpsWorksCMClient,
Aws\Organizations\OrganizationsClient,
Aws\Outposts\OutpostsClient,
Aws\Panorama\PanoramaClient,
Aws\ARCZonalShift\ARCZonalShiftClient,
Aws\Personalize\PersonalizeClient,
Aws\PersonalizeEvents\PersonalizeEventsClient,
Aws\PersonalizeRuntime\PersonalizeRuntimeClient,
Aws\PI\PIClient,
Aws\Pinpoint\PinpointClient,
Aws\PinpointEmail\PinpointEmailClient,
Aws\PinpointSMSVoice\PinpointSMSVoiceClient,
Aws\PinpointSMSVoiceV2\PinpointSMSVoiceV2Client,
Aws\Pipes\PipesClient,
Aws\Polly\PollyClient,
Aws\Athena\AthenaClient,
Aws\Pricing\PricingClient,
Aws\PrivateNetworks\PrivateNetworksClient,
Aws\PrometheusService\PrometheusServiceClient,
Aws\Proton\ProtonClient,
Aws\QLDB\QLDBClient,
Aws\QLDBSession\QLDBSessionClient,
Aws\QuickSight\QuickSightClient,
Aws\RAM\RAMClient,
Aws\Rds\RdsClient,
Aws\RDSDataService\RDSDataServiceClient,
Aws\AuditManager\AuditManagerClient,
Aws\RecycleBin\RecycleBinClient,
Aws\Redshift\RedshiftClient,
Aws\RedshiftDataAPIService\RedshiftDataAPIServiceClient,
Aws\RedshiftServerless\RedshiftServerlessClient,
Aws\Rekognition\RekognitionClient,
Aws\ResilienceHub\ResilienceHubClient,
Aws\ResourceExplorer2\ResourceExplorer2Client,
Aws\ResourceGroups\ResourceGroupsClient,
Aws\ResourceGroupsTaggingAPI\ResourceGroupsTaggingAPIClient,
Aws\RoboMaker\RoboMakerClient,
Aws\AugmentedAIRuntime\AugmentedAIRuntimeClient,
Aws\RolesAnywhere\RolesAnywhereClient,
Aws\Route53\Route53Client,
Aws\Route53Domains\Route53DomainsClient,
Aws\Route53RecoveryCluster\Route53RecoveryClusterClient,
Aws\Route53RecoveryControlConfig\Route53RecoveryControlConfigClient,
Aws\Route53RecoveryReadiness\Route53RecoveryReadinessClient,
Aws\Route53Resolver\Route53ResolverClient,
Aws\S3\S3Client,
Aws\S3\S3MultiRegionClient,
Aws\S3Control\S3ControlClient,
Aws\AutoScaling\AutoScalingClient,
Aws\S3Outposts\S3OutpostsClient,
Aws\SageMaker\SageMakerClient,
Aws\SagemakerEdgeManager\SagemakerEdgeManagerClient,
Aws\SageMakerFeatureStoreRuntime\SageMakerFeatureStoreRuntimeClient,
Aws\SageMakerGeospatial\SageMakerGeospatialClient,
Aws\SageMakerMetrics\SageMakerMetricsClient,
Aws\SageMakerRuntime\SageMakerRuntimeClient,
Aws\SavingsPlans\SavingsPlansClient,
Aws\Scheduler\SchedulerClient,
Aws\Schemas\SchemasClient,
Aws\AutoScalingPlans\AutoScalingPlansClient,
Aws\SecretsManager\SecretsManagerClient,
Aws\SecurityHub\SecurityHubClient,
Aws\SecurityLake\SecurityLakeClient,
Aws\ServerlessApplicationRepository\ServerlessApplicationRepositoryClient,
Aws\ServiceCatalog\ServiceCatalogClient,
Aws\ServiceDiscovery\ServiceDiscoveryClient,
Aws\ServiceQuotas\ServiceQuotasClient,
Aws\Ses\SesClient,
Aws\SesV2\SesV2Client,
Aws\Sfn\SfnClient,
Aws\ACMPCA\ACMPCAClient,
Aws\Backup\BackupClient,
Aws\Shield\ShieldClient,
Aws\signer\signerClient,
Aws\SimSpaceWeaver\SimSpaceWeaverClient,
Aws\Sms\SmsClient,
Aws\SnowBall\SnowBallClient,
Aws\SnowDeviceManagement\SnowDeviceManagementClient,
Aws\Sns\SnsClient,
Aws\Sqs\SqsClient,
Aws\Ssm\SsmClient,
Aws\SSMContacts\SSMContactsClient,
Aws\BackupGateway\BackupGatewayClient,
Aws\SSMIncidents\SSMIncidentsClient,
Aws\SsmSap\SsmSapClient,
Aws\SSO\SSOClient,
Aws\SSOAdmin\SSOAdminClient,
Aws\SSOOIDC\SSOOIDCClient,
Aws\StorageGateway\StorageGatewayClient,
Aws\Sts\StsClient,
Aws\Support\SupportClient,
Aws\SupportApp\SupportAppClient,
Aws\Swf\SwfClient,
Aws\BackupStorage\BackupStorageClient,
Aws\Synthetics\SyntheticsClient,
Aws\Textract\TextractClient,
Aws\TimestreamQuery\TimestreamQueryClient,
Aws\TimestreamWrite\TimestreamWriteClient,
Aws\TranscribeService\TranscribeServiceClient,
Aws\Transfer\TransferClient,
Aws\Translate\TranslateClient,
Aws\VoiceID\VoiceIDClient,
Aws\Waf\WafClient,
Aws\WafRegional\WafRegionalClient,
Aws\Batch\BatchClient,
Aws\WAFV2\WAFV2Client,
Aws\WellArchitected\WellArchitectedClient,
Aws\WorkDocs\WorkDocsClient,
Aws\WorkLink\WorkLinkClient,
Aws\WorkMail\WorkMailClient,
Aws\WorkMailMessageFlow\WorkMailMessageFlowClient,
Aws\WorkSpaces\WorkSpacesClient,
Aws\WorkSpacesWeb\WorkSpacesWebClient,
Aws\XRay\XRayClient,
Aws\BillingConductor\BillingConductorClient,
Aws\Braket\BraketClient,
Aws\Budgets\BudgetsClient,
Aws\Chime\ChimeClient,
Aws\ChimeSDKIdentity\ChimeSDKIdentityClient,
Aws\ChimeSDKMediaPipelines\ChimeSDKMediaPipelinesClient,
Aws\AlexaForBusiness\AlexaForBusinessClient,
Aws\ChimeSDKMeetings\ChimeSDKMeetingsClient,
Aws\ChimeSDKMessaging\ChimeSDKMessagingClient,
Aws\ChimeSDKVoice\ChimeSDKVoiceClient,
Aws\CleanRooms\CleanRoomsClient,
Aws\Cloud9\Cloud9Client,
Aws\CloudControlApi\CloudControlApiClient,
Aws\CloudDirectory\CloudDirectoryClient,
Aws\CloudFormation\CloudFormationClient,
Aws\CloudFront\CloudFrontClient,
Aws\CloudHsm\CloudHsmClient,
Aws\Amplify\AmplifyClient,
Aws\CloudHSMV2\CloudHSMV2Client,
Aws\CloudSearch\CloudSearchClient,
Aws\CloudSearchDomain\CloudSearchDomainClient,
Aws\CloudTrail\CloudTrailClient,
Aws\CloudTrailData\CloudTrailDataClient,
Aws\CloudWatch\CloudWatchClient,
Aws\CloudWatchEvents\CloudWatchEventsClient,
Aws\CloudWatchEvidently\CloudWatchEvidentlyClient,
Aws\CloudWatchLogs\CloudWatchLogsClient,
Aws\CloudWatchRUM\CloudWatchRUMClient,
Aws\AmplifyBackend\AmplifyBackendClient,
Aws\CodeArtifact\CodeArtifactClient,
Aws\CodeBuild\CodeBuildClient,
Aws\CodeCatalyst\CodeCatalystClient,
Aws\CodeCommit\CodeCommitClient,
Aws\CodeDeploy\CodeDeployClient,
Aws\CodeGuruProfiler\CodeGuruProfilerClient,
Aws\CodeGuruReviewer\CodeGuruReviewerClient,
Aws\CodePipeline\CodePipelineClient,
Aws\CodeStar\CodeStarClient,
Aws\CodeStarconnections\CodeStarconnectionsClient,
Aws\AmplifyUIBuilder\AmplifyUIBuilderClient,
Aws\CodeStarNotifications\CodeStarNotificationsClient,
Aws\CognitoIdentity\CognitoIdentityClient,
Aws\CognitoIdentityProvider\CognitoIdentityProviderClient,
Aws\CognitoSync\CognitoSyncClient,
Aws\Comprehend\ComprehendClient,
Aws\ComprehendMedical\ComprehendMedicalClient,
Aws\ComputeOptimizer\ComputeOptimizerClient,
Aws\ConfigService\ConfigServiceClient,
Aws\Connect\ConnectClient,
Aws\ConnectCampaignService\ConnectCampaignServiceClient,
Aws\ApiGateway\ApiGatewayClient,
Aws\ConnectCases\ConnectCasesClient,
Aws\ConnectContactLens\ConnectContactLensClient,
Aws\ConnectParticipant\ConnectParticipantClient,
Aws\ConnectWisdomService\ConnectWisdomServiceClient,
Aws\ControlTower\ControlTowerClient,
Aws\CostandUsageReportService\CostandUsageReportServiceClient,
Aws\CostExplorer\CostExplorerClient,
Aws\CustomerProfiles\CustomerProfilesClient,
Aws\DatabaseMigrationService\DatabaseMigrationServiceClient,
Aws\DataExchange\DataExchangeClient,
Aws\ApiGatewayManagementApi\ApiGatewayManagementApiClient,
Aws\DataPipeline\DataPipelineClient,
Aws\DataSync\DataSyncClient,
Aws\DAX\DAXClient,
Aws\Detective\DetectiveClient,
Aws\DeviceFarm\DeviceFarmClient,
Aws\DevOpsGuru\DevOpsGuruClient,
Aws\DirectConnect\DirectConnectClient,
Aws\DirectoryService\DirectoryServiceClient,
Aws\DLM\DLMClient,
Aws\DocDB\DocDBClient
Methods Summary
-
__call ( string $name, array $arguments )
Creates and executes a command for an operation by name.
-
getCommand ( string $name, array $args = [] )
Create a command for an operation name.
-
execute ( Aws\CommandInterface $command )
Execute a single command.
-
executeAsync ( Aws\CommandInterface $command )
Execute a command asynchronously.
-
getCredentials ( )
Returns a promise that is fulfilled with an
Aws\Credentials\CredentialsInterfaceobject. -
getRegion ( )
Get the region to which the client is configured to send requests.
-
getEndpoint ( )
Gets the default endpoint, or base URL, used by the client.
-
getApi ( )
Get the service description associated with the client.
-
getConfig ( string|null $option = null )
Get a client configuration value.
-
getHandlerList ( )
Get the handler list used to transfer commands.
-
getIterator ( string $name, array $args = [] )
Get a resource iterator for the specified operation.
-
getPaginator ( string $name, array $args = [] )
Get a result paginator for the specified operation.
-
waitUntil ( string|callable $name, array $args = [] )
Wait until a resource is in a particular state.
-
getWaiter ( string|callable $name, array $args = [] )
Get a waiter that waits until a resource is in a particular state.
Methods Details
Aws\ResultInterface
__call (
string
$name,
array
$arguments
)
Creates and executes a command for an operation by name.
Suffixing an operation name with "Async" will return a promise that can be used to execute commands asynchronously.
Parameters
| string | $name | Name of the command to execute. |
| array | $arguments | Arguments to pass to the getCommand method. |
Returns
Aws\ResultInterface |
Exceptions
| Exception |
Aws\CommandInterface
getCommand (
string
$name,
array
$args = []
)
Create a command for an operation name.
Special keys may be set on the command to control how it behaves, including:
- @http: Associative array of transfer specific options to apply to the request that is serialized for this command. Available keys include "proxy", "verify", "timeout", "connect_timeout", "debug", "delay", and "headers".
Parameters
| string | $name | Name of the operation to use in the command |
| array | $args = [] | Arguments to pass to the command |
Returns
Aws\CommandInterface |
Exceptions
| InvalidArgumentException if no command can be found by name |
Aws\ResultInterface
execute (
Aws\CommandInterface
$command
)
Execute a single command.
Parameters
Aws\CommandInterface |
$command | Command to execute |
Returns
Aws\ResultInterface |
Exceptions
| Exception |
GuzzleHttp\Promise\PromiseInterface
executeAsync (
Aws\CommandInterface
$command
)
Execute a command asynchronously.
Parameters
Aws\CommandInterface |
$command | Command to execute |
Returns
GuzzleHttp\Promise\PromiseInterface |
GuzzleHttp\Promise\PromiseInterface
getCredentials (
)
Returns a promise that is fulfilled with an
Aws\Credentials\CredentialsInterface object.
If you need the credentials synchronously, then call the wait() method on the returned promise.
Returns
GuzzleHttp\Promise\PromiseInterface |
string getRegion ( )
Get the region to which the client is configured to send requests.
Returns
| string |
Psr\Http\Message\UriInterface
getEndpoint (
)
Aws\Api\Service
getApi (
)
mixed|null getConfig ( string|null $option = null )
Get a client configuration value.
Parameters
| string|null | $option = null | The option to retrieve. Pass null to retrieve all options. |
Returns
| mixed|null |
Aws\HandlerList
getHandlerList (
)
Get the handler list used to transfer commands.
This list can be modified to add middleware or to change the underlying handler used to send HTTP requests.
Returns
Aws\HandlerList |
Iterator getIterator ( string $name, array $args = [] )
Get a resource iterator for the specified operation.
Parameters
| string | $name | Name of the iterator to retrieve. |
| array | $args = [] | Command arguments to use with each command. |
Returns
| Iterator |
Exceptions
| UnexpectedValueException if the iterator config is invalid. |
Aws\ResultPaginator
getPaginator (
string
$name,
array
$args = []
)
Get a result paginator for the specified operation.
Parameters
| string | $name | Name of the operation used for iterator |
| array | $args = [] | Command args to be used with each command |
Returns
Aws\ResultPaginator |
Exceptions
| UnexpectedValueException if the iterator config is invalid. |
waitUntil ( string|callable $name, array $args = [] )
Wait until a resource is in a particular state.
Parameters
| string|callable | $name | Name of the waiter that defines the wait configuration and conditions. |
| array | $args = [] | Args to be used with each command executed by the waiter. Waiter configuration options can be provided in an associative array in the @waiter key. |
Exceptions
| UnexpectedValueException if the waiter is invalid. |
Aws\Waiter
getWaiter (
string|callable
$name,
array
$args = []
)
Get a waiter that waits until a resource is in a particular state.
Retrieving a waiter can be useful when you wish to wait asynchronously: $waiter = $client->getWaiter('foo', ['bar' => 'baz']); $waiter->promise()->then(function () { echo 'Done!'; });
Parameters
| string|callable | $name | Name of the waiter that defines the wait configuration and conditions. |
| array | $args = [] | Args to be used with each command executed by the waiter. Waiter configuration options can be provided in an associative array in the @waiter key. |
Returns
Aws\Waiter |
Exceptions
| UnexpectedValueException if the waiter is invalid. |