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\CustomerProfiles\CustomerProfilesClient
,
Aws\DatabaseMigrationService\DatabaseMigrationServiceClient
,
Aws\DataExchange\DataExchangeClient
,
Aws\DataPipeline\DataPipelineClient
,
Aws\DataSync\DataSyncClient
,
Aws\DataZone\DataZoneClient
,
Aws\DAX\DAXClient
,
Aws\Detective\DetectiveClient
,
Aws\DeviceFarm\DeviceFarmClient
,
Aws\DevOpsGuru\DevOpsGuruClient
,
Aws\AppConfig\AppConfigClient
,
Aws\DirectConnect\DirectConnectClient
,
Aws\DirectoryService\DirectoryServiceClient
,
Aws\DLM\DLMClient
,
Aws\DocDB\DocDBClient
,
Aws\DocDBElastic\DocDBElasticClient
,
Aws\drs\drsClient
,
Aws\DynamoDb\DynamoDbClient
,
Aws\DynamoDbStreams\DynamoDbStreamsClient
,
Aws\EBS\EBSClient
,
Aws\Ec2\Ec2Client
,
Aws\AppConfigData\AppConfigDataClient
,
Aws\EC2InstanceConnect\EC2InstanceConnectClient
,
Aws\Ecr\EcrClient
,
Aws\ECRPublic\ECRPublicClient
,
Aws\Ecs\EcsClient
,
Aws\Efs\EfsClient
,
Aws\EKS\EKSClient
,
Aws\EKSAuth\EKSAuthClient
,
Aws\ElastiCache\ElastiCacheClient
,
Aws\ElasticBeanstalk\ElasticBeanstalkClient
,
Aws\ElasticInference\ElasticInferenceClient
,
Aws\AppFabric\AppFabricClient
,
Aws\ElasticLoadBalancing\ElasticLoadBalancingClient
,
Aws\ElasticLoadBalancingV2\ElasticLoadBalancingV2Client
,
Aws\ElasticsearchService\ElasticsearchServiceClient
,
Aws\ElasticTranscoder\ElasticTranscoderClient
,
Aws\Emr\EmrClient
,
Aws\EMRContainers\EMRContainersClient
,
Aws\EMRServerless\EMRServerlessClient
,
Aws\EntityResolution\EntityResolutionClient
,
Aws\EventBridge\EventBridgeClient
,
Aws\finspace\finspaceClient
,
Aws\Appflow\AppflowClient
,
Aws\FinSpaceData\FinSpaceDataClient
,
Aws\Firehose\FirehoseClient
,
Aws\FIS\FISClient
,
Aws\FMS\FMSClient
,
Aws\ForecastQueryService\ForecastQueryServiceClient
,
Aws\ForecastService\ForecastServiceClient
,
Aws\FraudDetector\FraudDetectorClient
,
Aws\FreeTier\FreeTierClient
,
Aws\FSx\FSxClient
,
Aws\GameLift\GameLiftClient
,
Aws\AppIntegrationsService\AppIntegrationsServiceClient
,
Aws\Glacier\GlacierClient
,
Aws\GlobalAccelerator\GlobalAcceleratorClient
,
Aws\Glue\GlueClient
,
Aws\GlueDataBrew\GlueDataBrewClient
,
Aws\Greengrass\GreengrassClient
,
Aws\GreengrassV2\GreengrassV2Client
,
Aws\GroundStation\GroundStationClient
,
Aws\GuardDuty\GuardDutyClient
,
Aws\Health\HealthClient
,
Aws\HealthLake\HealthLakeClient
,
Aws\ApplicationAutoScaling\ApplicationAutoScalingClient
,
Aws\Honeycode\HoneycodeClient
,
Aws\Iam\IamClient
,
Aws\IdentityStore\IdentityStoreClient
,
Aws\imagebuilder\imagebuilderClient
,
Aws\ImportExport\ImportExportClient
,
Aws\Inspector2\Inspector2Client
,
Aws\Inspector\InspectorClient
,
Aws\InspectorScan\InspectorScanClient
,
Aws\InternetMonitor\InternetMonitorClient
,
Aws\IoT1ClickDevicesService\IoT1ClickDevicesServiceClient
,
Aws\ApplicationCostProfiler\ApplicationCostProfilerClient
,
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\IoTFleetWise\IoTFleetWiseClient
,
Aws\IoTJobsDataPlane\IoTJobsDataPlaneClient
,
Aws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient
,
Aws\IoTSecureTunneling\IoTSecureTunnelingClient
,
Aws\IoTSiteWise\IoTSiteWiseClient
,
Aws\IoTThingsGraph\IoTThingsGraphClient
,
Aws\IoTTwinMaker\IoTTwinMakerClient
,
Aws\IoTWireless\IoTWirelessClient
,
Aws\IVS\IVSClient
,
Aws\ivschat\ivschatClient
,
Aws\IVSRealTime\IVSRealTimeClient
,
Aws\Kafka\KafkaClient
,
Aws\KafkaConnect\KafkaConnectClient
,
Aws\ApplicationInsights\ApplicationInsightsClient
,
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\KinesisVideoMedia\KinesisVideoMediaClient
,
Aws\KinesisVideoSignalingChannels\KinesisVideoSignalingChannelsClient
,
Aws\Acm\AcmClient
,
Aws\AppMesh\AppMeshClient
,
Aws\KinesisVideoWebRTCStorage\KinesisVideoWebRTCStorageClient
,
Aws\Kms\KmsClient
,
Aws\LakeFormation\LakeFormationClient
,
Aws\Lambda\LambdaClient
,
Aws\LaunchWizard\LaunchWizardClient
,
Aws\LexModelBuildingService\LexModelBuildingServiceClient
,
Aws\LexModelsV2\LexModelsV2Client
,
Aws\LexRuntimeService\LexRuntimeServiceClient
,
Aws\LexRuntimeV2\LexRuntimeV2Client
,
Aws\LicenseManager\LicenseManagerClient
,
Aws\AppRegistry\AppRegistryClient
,
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\MainframeModernization\MainframeModernizationClient
,
Aws\AppRunner\AppRunnerClient
,
Aws\ManagedBlockchain\ManagedBlockchainClient
,
Aws\ManagedBlockchainQuery\ManagedBlockchainQueryClient
,
Aws\ManagedGrafana\ManagedGrafanaClient
,
Aws\MarketplaceAgreement\MarketplaceAgreementClient
,
Aws\MarketplaceCatalog\MarketplaceCatalogClient
,
Aws\MarketplaceCommerceAnalytics\MarketplaceCommerceAnalyticsClient
,
Aws\MarketplaceDeployment\MarketplaceDeploymentClient
,
Aws\MarketplaceEntitlementService\MarketplaceEntitlementServiceClient
,
Aws\MarketplaceMetering\MarketplaceMeteringClient
,
Aws\MediaConnect\MediaConnectClient
,
Aws\Appstream\AppstreamClient
,
Aws\MediaConvert\MediaConvertClient
,
Aws\MediaLive\MediaLiveClient
,
Aws\MediaPackage\MediaPackageClient
,
Aws\MediaPackageV2\MediaPackageV2Client
,
Aws\MediaPackageVod\MediaPackageVodClient
,
Aws\MediaStore\MediaStoreClient
,
Aws\MediaStoreData\MediaStoreDataClient
,
Aws\MediaTailor\MediaTailorClient
,
Aws\MedicalImaging\MedicalImagingClient
,
Aws\MemoryDB\MemoryDBClient
,
Aws\AppSync\AppSyncClient
,
Aws\mgn\mgnClient
,
Aws\MigrationHub\MigrationHubClient
,
Aws\MigrationHubConfig\MigrationHubConfigClient
,
Aws\MigrationHubOrchestrator\MigrationHubOrchestratorClient
,
Aws\MigrationHubRefactorSpaces\MigrationHubRefactorSpacesClient
,
Aws\MigrationHubStrategyRecommendations\MigrationHubStrategyRecommendationsClient
,
Aws\Mobile\MobileClient
,
Aws\MQ\MQClient
,
Aws\MTurk\MTurkClient
,
Aws\MWAA\MWAAClient
,
Aws\ARCZonalShift\ARCZonalShiftClient
,
Aws\Neptune\NeptuneClient
,
Aws\Neptunedata\NeptunedataClient
,
Aws\NeptuneGraph\NeptuneGraphClient
,
Aws\NetworkFirewall\NetworkFirewallClient
,
Aws\NetworkManager\NetworkManagerClient
,
Aws\NetworkMonitor\NetworkMonitorClient
,
Aws\NimbleStudio\NimbleStudioClient
,
Aws\OAM\OAMClient
,
Aws\Omics\OmicsClient
,
Aws\OpenSearchServerless\OpenSearchServerlessClient
,
Aws\Artifact\ArtifactClient
,
Aws\OpenSearchService\OpenSearchServiceClient
,
Aws\OpsWorks\OpsWorksClient
,
Aws\OpsWorksCM\OpsWorksCMClient
,
Aws\Organizations\OrganizationsClient
,
Aws\OSIS\OSISClient
,
Aws\Outposts\OutpostsClient
,
Aws\Panorama\PanoramaClient
,
Aws\PaymentCryptography\PaymentCryptographyClient
,
Aws\PaymentCryptographyData\PaymentCryptographyDataClient
,
Aws\PcaConnectorAd\PcaConnectorAdClient
,
Aws\Athena\AthenaClient
,
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\AuditManager\AuditManagerClient
,
Aws\Pricing\PricingClient
,
Aws\PrivateNetworks\PrivateNetworksClient
,
Aws\PrometheusService\PrometheusServiceClient
,
Aws\Proton\ProtonClient
,
Aws\QBusiness\QBusinessClient
,
Aws\QConnect\QConnectClient
,
Aws\QLDB\QLDBClient
,
Aws\QLDBSession\QLDBSessionClient
,
Aws\QuickSight\QuickSightClient
,
Aws\RAM\RAMClient
,
Aws\AugmentedAIRuntime\AugmentedAIRuntimeClient
,
Aws\Rds\RdsClient
,
Aws\RDSDataService\RDSDataServiceClient
,
Aws\RecycleBin\RecycleBinClient
,
Aws\Redshift\RedshiftClient
,
Aws\RedshiftDataAPIService\RedshiftDataAPIServiceClient
,
Aws\RedshiftServerless\RedshiftServerlessClient
,
Aws\Rekognition\RekognitionClient
,
Aws\Repostspace\RepostspaceClient
,
Aws\ResilienceHub\ResilienceHubClient
,
Aws\ResourceExplorer2\ResourceExplorer2Client
,
Aws\ACMPCA\ACMPCAClient
,
Aws\AutoScaling\AutoScalingClient
,
Aws\ResourceGroups\ResourceGroupsClient
,
Aws\ResourceGroupsTaggingAPI\ResourceGroupsTaggingAPIClient
,
Aws\RoboMaker\RoboMakerClient
,
Aws\RolesAnywhere\RolesAnywhereClient
,
Aws\Route53\Route53Client
,
Aws\Route53Domains\Route53DomainsClient
,
Aws\Route53RecoveryCluster\Route53RecoveryClusterClient
,
Aws\Route53RecoveryControlConfig\Route53RecoveryControlConfigClient
,
Aws\Route53RecoveryReadiness\Route53RecoveryReadinessClient
,
Aws\Route53Resolver\Route53ResolverClient
,
Aws\AutoScalingPlans\AutoScalingPlansClient
,
Aws\S3\S3Client
,
Aws\S3\S3MultiRegionClient
,
Aws\S3Control\S3ControlClient
,
Aws\S3Outposts\S3OutpostsClient
,
Aws\SageMaker\SageMakerClient
,
Aws\SagemakerEdgeManager\SagemakerEdgeManagerClient
,
Aws\SageMakerFeatureStoreRuntime\SageMakerFeatureStoreRuntimeClient
,
Aws\SageMakerGeospatial\SageMakerGeospatialClient
,
Aws\SageMakerMetrics\SageMakerMetricsClient
,
Aws\SageMakerRuntime\SageMakerRuntimeClient
,
Aws\B2bi\B2biClient
,
Aws\SavingsPlans\SavingsPlansClient
,
Aws\Scheduler\SchedulerClient
,
Aws\Schemas\SchemasClient
,
Aws\SecretsManager\SecretsManagerClient
,
Aws\SecurityHub\SecurityHubClient
,
Aws\SecurityLake\SecurityLakeClient
,
Aws\ServerlessApplicationRepository\ServerlessApplicationRepositoryClient
,
Aws\ServiceCatalog\ServiceCatalogClient
,
Aws\ServiceDiscovery\ServiceDiscoveryClient
,
Aws\ServiceQuotas\ServiceQuotasClient
,
Aws\Backup\BackupClient
,
Aws\Ses\SesClient
,
Aws\SesV2\SesV2Client
,
Aws\Sfn\SfnClient
,
Aws\Shield\ShieldClient
,
Aws\signer\signerClient
,
Aws\SimSpaceWeaver\SimSpaceWeaverClient
,
Aws\Sms\SmsClient
,
Aws\SnowBall\SnowBallClient
,
Aws\SnowDeviceManagement\SnowDeviceManagementClient
,
Aws\Sns\SnsClient
,
Aws\BackupGateway\BackupGatewayClient
,
Aws\Sqs\SqsClient
,
Aws\Ssm\SsmClient
,
Aws\SSMContacts\SSMContactsClient
,
Aws\SSMIncidents\SSMIncidentsClient
,
Aws\SsmSap\SsmSapClient
,
Aws\SSO\SSOClient
,
Aws\SSOAdmin\SSOAdminClient
,
Aws\SSOOIDC\SSOOIDCClient
,
Aws\StorageGateway\StorageGatewayClient
,
Aws\Sts\StsClient
,
Aws\BackupStorage\BackupStorageClient
,
Aws\SupplyChain\SupplyChainClient
,
Aws\Support\SupportClient
,
Aws\SupportApp\SupportAppClient
,
Aws\Swf\SwfClient
,
Aws\Synthetics\SyntheticsClient
,
Aws\Textract\TextractClient
,
Aws\TimestreamInfluxDB\TimestreamInfluxDBClient
,
Aws\TimestreamQuery\TimestreamQueryClient
,
Aws\TimestreamWrite\TimestreamWriteClient
,
Aws\Tnb\TnbClient
,
Aws\Batch\BatchClient
,
Aws\TranscribeService\TranscribeServiceClient
,
Aws\Transfer\TransferClient
,
Aws\Translate\TranslateClient
,
Aws\TrustedAdvisor\TrustedAdvisorClient
,
Aws\VerifiedPermissions\VerifiedPermissionsClient
,
Aws\VoiceID\VoiceIDClient
,
Aws\VPCLattice\VPCLatticeClient
,
Aws\Waf\WafClient
,
Aws\WafRegional\WafRegionalClient
,
Aws\WAFV2\WAFV2Client
,
Aws\BCMDataExports\BCMDataExportsClient
,
Aws\WellArchitected\WellArchitectedClient
,
Aws\WorkDocs\WorkDocsClient
,
Aws\WorkLink\WorkLinkClient
,
Aws\WorkMail\WorkMailClient
,
Aws\WorkMailMessageFlow\WorkMailMessageFlowClient
,
Aws\WorkSpaces\WorkSpacesClient
,
Aws\WorkSpacesThinClient\WorkSpacesThinClientClient
,
Aws\WorkSpacesWeb\WorkSpacesWebClient
,
Aws\XRay\XRayClient
,
Aws\Bedrock\BedrockClient
,
Aws\BedrockAgent\BedrockAgentClient
,
Aws\AlexaForBusiness\AlexaForBusinessClient
,
Aws\BedrockAgentRuntime\BedrockAgentRuntimeClient
,
Aws\BedrockRuntime\BedrockRuntimeClient
,
Aws\BillingConductor\BillingConductorClient
,
Aws\Braket\BraketClient
,
Aws\Budgets\BudgetsClient
,
Aws\Chatbot\ChatbotClient
,
Aws\Chime\ChimeClient
,
Aws\ChimeSDKIdentity\ChimeSDKIdentityClient
,
Aws\ChimeSDKMediaPipelines\ChimeSDKMediaPipelinesClient
,
Aws\ChimeSDKMeetings\ChimeSDKMeetingsClient
,
Aws\Amplify\AmplifyClient
,
Aws\ChimeSDKMessaging\ChimeSDKMessagingClient
,
Aws\ChimeSDKVoice\ChimeSDKVoiceClient
,
Aws\CleanRooms\CleanRoomsClient
,
Aws\CleanRoomsML\CleanRoomsMLClient
,
Aws\Cloud9\Cloud9Client
,
Aws\CloudControlApi\CloudControlApiClient
,
Aws\CloudDirectory\CloudDirectoryClient
,
Aws\CloudFormation\CloudFormationClient
,
Aws\CloudFront\CloudFrontClient
,
Aws\CloudFrontKeyValueStore\CloudFrontKeyValueStoreClient
,
Aws\AmplifyBackend\AmplifyBackendClient
,
Aws\CloudHsm\CloudHsmClient
,
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\AmplifyUIBuilder\AmplifyUIBuilderClient
,
Aws\CloudWatchRUM\CloudWatchRUMClient
,
Aws\CodeArtifact\CodeArtifactClient
,
Aws\CodeBuild\CodeBuildClient
,
Aws\CodeCatalyst\CodeCatalystClient
,
Aws\CodeCommit\CodeCommitClient
,
Aws\CodeDeploy\CodeDeployClient
,
Aws\CodeGuruProfiler\CodeGuruProfilerClient
,
Aws\CodeGuruReviewer\CodeGuruReviewerClient
,
Aws\CodeGuruSecurity\CodeGuruSecurityClient
,
Aws\CodePipeline\CodePipelineClient
,
Aws\ApiGateway\ApiGatewayClient
,
Aws\CodeStar\CodeStarClient
,
Aws\CodeStarconnections\CodeStarconnectionsClient
,
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\ApiGatewayManagementApi\ApiGatewayManagementApiClient
,
Aws\Connect\ConnectClient
,
Aws\ConnectCampaignService\ConnectCampaignServiceClient
,
Aws\ConnectCases\ConnectCasesClient
,
Aws\ConnectContactLens\ConnectContactLensClient
,
Aws\ConnectParticipant\ConnectParticipantClient
,
Aws\ConnectWisdomService\ConnectWisdomServiceClient
,
Aws\ControlTower\ControlTowerClient
,
Aws\CostandUsageReportService\CostandUsageReportServiceClient
,
Aws\CostExplorer\CostExplorerClient
,
Aws\CostOptimizationHub\CostOptimizationHubClient
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\CredentialsInterface
object. -
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. |