SDK for PHP 3.x

Documentation

This API documentation for the AWS SDK for PHP documents every namespace, class, and method in the SDK and its required dependencies. More importantly, it describes each of the services' APIs, including the parameter and result structures for each operation, so you can see how to use the operations in your PHP code. To view the API documentation for a particular service, look in the table below. To view API documentation for various classes in the SDK, use the namespace and class trees in the left sidebar.

Service APIs

Service Name Client Class API Version
Access AnalyzerAws\AccessAnalyzer\AccessAnalyzerClient
AWS AccountAws\Account\AccountClient
AWS Certificate ManagerAws\Acm\AcmClient
AWS Certificate Manager Private Certificate AuthorityAws\ACMPCA\ACMPCAClient
AWS AmplifyAws\Amplify\AmplifyClient
AmplifyBackendAws\AmplifyBackend\AmplifyBackendClient
AWS Amplify UI BuilderAws\AmplifyUIBuilder\AmplifyUIBuilderClient
Amazon API GatewayAws\ApiGateway\ApiGatewayClient
AmazonApiGatewayManagementApiAws\ApiGatewayManagementApi\ApiGatewayManagementApiClient
AmazonApiGatewayV2Aws\ApiGatewayV2\ApiGatewayV2Client
Amazon AppConfigAws\AppConfig\AppConfigClient
AWS AppConfig DataAws\AppConfigData\AppConfigDataClient
AppFabricAws\AppFabric\AppFabricClient
Amazon AppflowAws\Appflow\AppflowClient
Amazon AppIntegrations ServiceAws\AppIntegrationsService\AppIntegrationsServiceClient
Application Auto ScalingAws\ApplicationAutoScaling\ApplicationAutoScalingClient
AWS Application Cost ProfilerAws\ApplicationCostProfiler\ApplicationCostProfilerClient
AWS Application Discovery ServiceAws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient
Amazon CloudWatch Application InsightsAws\ApplicationInsights\ApplicationInsightsClient
Amazon CloudWatch Application SignalsAws\ApplicationSignals\ApplicationSignalsClient
AWS App MeshAws\AppMesh\AppMeshClient
AWS Service Catalog App RegistryAws\AppRegistry\AppRegistryClient
AWS App RunnerAws\AppRunner\AppRunnerClient
Amazon AppStreamAws\Appstream\AppstreamClient
AWS AppSyncAws\AppSync\AppSyncClient
AWS Mainframe Modernization Application TestingAws\AppTest\AppTestClient
AWS ARC - Zonal ShiftAws\ARCZonalShift\ARCZonalShiftClient
AWS ArtifactAws\Artifact\ArtifactClient
Amazon AthenaAws\Athena\AthenaClient
AWS Audit ManagerAws\AuditManager\AuditManagerClient
Amazon Augmented AI RuntimeAws\AugmentedAIRuntime\AugmentedAIRuntimeClient
Auto ScalingAws\AutoScaling\AutoScalingClient
AWS Auto Scaling PlansAws\AutoScalingPlans\AutoScalingPlansClient
AWS B2B Data InterchangeAws\B2bi\B2biClient
AWS BackupAws\Backup\BackupClient
AWS Backup GatewayAws\BackupGateway\BackupGatewayClient
AWS BatchAws\Batch\BatchClient
AWS Billing and Cost Management Data ExportsAws\BCMDataExports\BCMDataExportsClient
Amazon BedrockAws\Bedrock\BedrockClient
Agents for Amazon BedrockAws\BedrockAgent\BedrockAgentClient
Agents for Amazon Bedrock RuntimeAws\BedrockAgentRuntime\BedrockAgentRuntimeClient
Amazon Bedrock RuntimeAws\BedrockRuntime\BedrockRuntimeClient
AWSBillingConductorAws\BillingConductor\BillingConductorClient
BraketAws\Braket\BraketClient
AWS BudgetsAws\Budgets\BudgetsClient
AWS ChatbotAws\Chatbot\ChatbotClient
Amazon ChimeAws\Chime\ChimeClient
Amazon Chime SDK IdentityAws\ChimeSDKIdentity\ChimeSDKIdentityClient
Amazon Chime SDK Media PipelinesAws\ChimeSDKMediaPipelines\ChimeSDKMediaPipelinesClient
Amazon Chime SDK MeetingsAws\ChimeSDKMeetings\ChimeSDKMeetingsClient
Amazon Chime SDK MessagingAws\ChimeSDKMessaging\ChimeSDKMessagingClient
Amazon Chime SDK VoiceAws\ChimeSDKVoice\ChimeSDKVoiceClient
AWS Clean Rooms ServiceAws\CleanRooms\CleanRoomsClient
AWS Clean Rooms MLAws\CleanRoomsML\CleanRoomsMLClient
AWS Cloud9Aws\Cloud9\Cloud9Client
AWS Cloud Control APIAws\CloudControlApi\CloudControlApiClient
Amazon CloudDirectoryAws\CloudDirectory\CloudDirectoryClient
AWS CloudFormationAws\CloudFormation\CloudFormationClient
Amazon CloudFrontAws\CloudFront\CloudFrontClient
Amazon CloudFront KeyValueStoreAws\CloudFrontKeyValueStore\CloudFrontKeyValueStoreClient
Amazon CloudHSMAws\CloudHsm\CloudHsmClient
AWS CloudHSM V2Aws\CloudHSMV2\CloudHSMV2Client
Amazon CloudSearchAws\CloudSearch\CloudSearchClient
Amazon CloudSearch DomainAws\CloudSearchDomain\CloudSearchDomainClient
AWS CloudTrailAws\CloudTrail\CloudTrailClient
AWS CloudTrail Data ServiceAws\CloudTrailData\CloudTrailDataClient
Amazon CloudWatchAws\CloudWatch\CloudWatchClient
Amazon CloudWatch EventsAws\CloudWatchEvents\CloudWatchEventsClient
Amazon CloudWatch EvidentlyAws\CloudWatchEvidently\CloudWatchEvidentlyClient
Amazon CloudWatch LogsAws\CloudWatchLogs\CloudWatchLogsClient
CloudWatch RUMAws\CloudWatchRUM\CloudWatchRUMClient
CodeArtifactAws\CodeArtifact\CodeArtifactClient
AWS CodeBuildAws\CodeBuild\CodeBuildClient
Amazon CodeCatalystAws\CodeCatalyst\CodeCatalystClient
AWS CodeCommitAws\CodeCommit\CodeCommitClient
AWS CodeConnectionsAws\CodeConnections\CodeConnectionsClient
AWS CodeDeployAws\CodeDeploy\CodeDeployClient
Amazon CodeGuru ProfilerAws\CodeGuruProfiler\CodeGuruProfilerClient
Amazon CodeGuru ReviewerAws\CodeGuruReviewer\CodeGuruReviewerClient
Amazon CodeGuru SecurityAws\CodeGuruSecurity\CodeGuruSecurityClient
AWS CodePipelineAws\CodePipeline\CodePipelineClient
AWS CodeStar connectionsAws\CodeStarconnections\CodeStarconnectionsClient
AWS CodeStar NotificationsAws\CodeStarNotifications\CodeStarNotificationsClient
Amazon Cognito IdentityAws\CognitoIdentity\CognitoIdentityClient
Amazon Cognito Identity ProviderAws\CognitoIdentityProvider\CognitoIdentityProviderClient
Amazon Cognito SyncAws\CognitoSync\CognitoSyncClient
Amazon ComprehendAws\Comprehend\ComprehendClient
AWS Comprehend MedicalAws\ComprehendMedical\ComprehendMedicalClient
AWS Compute OptimizerAws\ComputeOptimizer\ComputeOptimizerClient
AWS ConfigAws\ConfigService\ConfigServiceClient
Amazon Connect ServiceAws\Connect\ConnectClient
AmazonConnectCampaignServiceAws\ConnectCampaignService\ConnectCampaignServiceClient
Amazon Connect CasesAws\ConnectCases\ConnectCasesClient
Amazon Connect Contact LensAws\ConnectContactLens\ConnectContactLensClient
Amazon Connect Participant ServiceAws\ConnectParticipant\ConnectParticipantClient
Amazon Connect Wisdom ServiceAws\ConnectWisdomService\ConnectWisdomServiceClient
AWS Control CatalogAws\ControlCatalog\ControlCatalogClient
AWS Control TowerAws\ControlTower\ControlTowerClient
AWS Cost and Usage Report ServiceAws\CostandUsageReportService\CostandUsageReportServiceClient
AWS Cost Explorer ServiceAws\CostExplorer\CostExplorerClient
Cost Optimization HubAws\CostOptimizationHub\CostOptimizationHubClient
Amazon Connect Customer ProfilesAws\CustomerProfiles\CustomerProfilesClient
AWS Database Migration ServiceAws\DatabaseMigrationService\DatabaseMigrationServiceClient
AWS Data ExchangeAws\DataExchange\DataExchangeClient
AWS Data PipelineAws\DataPipeline\DataPipelineClient
AWS DataSyncAws\DataSync\DataSyncClient
Amazon DataZoneAws\DataZone\DataZoneClient
Amazon DynamoDB Accelerator (DAX)Aws\DAX\DAXClient
AWSDeadlineCloudAws\Deadline\DeadlineClient
Amazon DetectiveAws\Detective\DetectiveClient
AWS Device FarmAws\DeviceFarm\DeviceFarmClient
Amazon DevOps GuruAws\DevOpsGuru\DevOpsGuruClient
AWS Direct ConnectAws\DirectConnect\DirectConnectClient
AWS Directory ServiceAws\DirectoryService\DirectoryServiceClient
AWS Directory Service DataAws\DirectoryServiceData\DirectoryServiceDataClient
Amazon Data Lifecycle ManagerAws\DLM\DLMClient
Amazon DocumentDB with MongoDB compatibilityAws\DocDB\DocDBClient
Amazon DocumentDB Elastic ClustersAws\DocDBElastic\DocDBElasticClient
Elastic Disaster Recovery ServiceAws\drs\drsClient
Amazon DynamoDBAws\DynamoDb\DynamoDbClient
Amazon DynamoDB StreamsAws\DynamoDbStreams\DynamoDbStreamsClient
Amazon Elastic Block StoreAws\EBS\EBSClient
Amazon Elastic Compute CloudAws\Ec2\Ec2Client
AWS EC2 Instance ConnectAws\EC2InstanceConnect\EC2InstanceConnectClient
Amazon Elastic Container RegistryAws\Ecr\EcrClient
Amazon Elastic Container Registry PublicAws\ECRPublic\ECRPublicClient
Amazon EC2 Container ServiceAws\Ecs\EcsClient
Amazon Elastic File SystemAws\Efs\EfsClient
Amazon Elastic Kubernetes ServiceAws\EKS\EKSClient
Amazon EKS AuthAws\EKSAuth\EKSAuthClient
Amazon ElastiCacheAws\ElastiCache\ElastiCacheClient
AWS Elastic BeanstalkAws\ElasticBeanstalk\ElasticBeanstalkClient
Amazon Elastic InferenceAws\ElasticInference\ElasticInferenceClient
Elastic Load BalancingAws\ElasticLoadBalancing\ElasticLoadBalancingClient
Elastic Load BalancingAws\ElasticLoadBalancingV2\ElasticLoadBalancingV2Client
Amazon Elasticsearch ServiceAws\ElasticsearchService\ElasticsearchServiceClient
Amazon Elastic TranscoderAws\ElasticTranscoder\ElasticTranscoderClient
Amazon EMRAws\Emr\EmrClient
Amazon EMR ContainersAws\EMRContainers\EMRContainersClient
EMR ServerlessAws\EMRServerless\EMRServerlessClient
AWS EntityResolutionAws\EntityResolution\EntityResolutionClient
Amazon EventBridgeAws\EventBridge\EventBridgeClient
FinSpace User Environment Management serviceAws\finspace\finspaceClient
FinSpace Public APIAws\FinSpaceData\FinSpaceDataClient
Amazon Kinesis FirehoseAws\Firehose\FirehoseClient
AWS Fault Injection SimulatorAws\FIS\FISClient
Firewall Management ServiceAws\FMS\FMSClient
Amazon Forecast Query ServiceAws\ForecastQueryService\ForecastQueryServiceClient
Amazon Forecast ServiceAws\ForecastService\ForecastServiceClient
Amazon Fraud DetectorAws\FraudDetector\FraudDetectorClient
AWS Free TierAws\FreeTier\FreeTierClient
Amazon FSxAws\FSx\FSxClient
Amazon GameLiftAws\GameLift\GameLiftClient
Amazon Location Service Maps V2Aws\GeoMaps\GeoMapsClient
Amazon Location Service Places V2Aws\GeoPlaces\GeoPlacesClient
Amazon Location Service Routes V2Aws\GeoRoutes\GeoRoutesClient
Amazon GlacierAws\Glacier\GlacierClient
AWS Global AcceleratorAws\GlobalAccelerator\GlobalAcceleratorClient
AWS GlueAws\Glue\GlueClient
AWS Glue DataBrewAws\GlueDataBrew\GlueDataBrewClient
AWS GreengrassAws\Greengrass\GreengrassClient
AWS IoT Greengrass V2Aws\GreengrassV2\GreengrassV2Client
AWS Ground StationAws\GroundStation\GroundStationClient
Amazon GuardDutyAws\GuardDuty\GuardDutyClient
AWS Health APIs and NotificationsAws\Health\HealthClient
Amazon HealthLakeAws\HealthLake\HealthLakeClient
AWS Identity and Access ManagementAws\Iam\IamClient
AWS SSO Identity StoreAws\IdentityStore\IdentityStoreClient
EC2 Image BuilderAws\imagebuilder\imagebuilderClient
AWS Import/ExportAws\ImportExport\ImportExportClient
Amazon InspectorAws\Inspector\InspectorClient
Inspector2Aws\Inspector2\Inspector2Client
Inspector ScanAws\InspectorScan\InspectorScanClient
Amazon CloudWatch Internet MonitorAws\InternetMonitor\InternetMonitorClient
AWS IoTAws\Iot\IotClient
AWS IoT 1-Click Devices ServiceAws\IoT1ClickDevicesService\IoT1ClickDevicesServiceClient
AWS IoT 1-Click Projects ServiceAws\IoT1ClickProjects\IoT1ClickProjectsClient
AWS IoT AnalyticsAws\IoTAnalytics\IoTAnalyticsClient
AWS IoT Data PlaneAws\IotDataPlane\IotDataPlaneClient
AWS IoT Core Device AdvisorAws\IoTDeviceAdvisor\IoTDeviceAdvisorClient
AWS IoT EventsAws\IoTEvents\IoTEventsClient
AWS IoT Events DataAws\IoTEventsData\IoTEventsDataClient
AWS IoT Fleet HubAws\IoTFleetHub\IoTFleetHubClient
AWS IoT FleetWiseAws\IoTFleetWise\IoTFleetWiseClient
AWS IoT Jobs Data PlaneAws\IoTJobsDataPlane\IoTJobsDataPlaneClient
AWS IoT Secure TunnelingAws\IoTSecureTunneling\IoTSecureTunnelingClient
AWS IoT SiteWiseAws\IoTSiteWise\IoTSiteWiseClient
AWS IoT Things GraphAws\IoTThingsGraph\IoTThingsGraphClient
AWS IoT TwinMakerAws\IoTTwinMaker\IoTTwinMakerClient
AWS IoT WirelessAws\IoTWireless\IoTWirelessClient
Amazon Interactive Video ServiceAws\IVS\IVSClient
Amazon Interactive Video Service ChatAws\ivschat\ivschatClient
Amazon Interactive Video Service RealTimeAws\IVSRealTime\IVSRealTimeClient
Managed Streaming for KafkaAws\Kafka\KafkaClient
Managed Streaming for Kafka ConnectAws\KafkaConnect\KafkaConnectClient
AWSKendraFrontendServiceAws\kendra\kendraClient
Amazon Kendra Intelligent RankingAws\KendraRanking\KendraRankingClient
Amazon KeyspacesAws\Keyspaces\KeyspacesClient
Amazon KinesisAws\Kinesis\KinesisClient
Amazon Kinesis AnalyticsAws\KinesisAnalytics\KinesisAnalyticsClient
Amazon Kinesis AnalyticsAws\KinesisAnalyticsV2\KinesisAnalyticsV2Client
Amazon Kinesis Video StreamsAws\KinesisVideo\KinesisVideoClient
Amazon Kinesis Video Streams Archived MediaAws\KinesisVideoArchivedMedia\KinesisVideoArchivedMediaClient
Amazon Kinesis Video Streams MediaAws\KinesisVideoMedia\KinesisVideoMediaClient
Amazon Kinesis Video Signaling ChannelsAws\KinesisVideoSignalingChannels\KinesisVideoSignalingChannelsClient
Amazon Kinesis Video WebRTC StorageAws\KinesisVideoWebRTCStorage\KinesisVideoWebRTCStorageClient
AWS Key Management ServiceAws\Kms\KmsClient
AWS Lake FormationAws\LakeFormation\LakeFormationClient
AWS LambdaAws\Lambda\LambdaClient
AWS Launch WizardAws\LaunchWizard\LaunchWizardClient
Amazon Lex Model Building ServiceAws\LexModelBuildingService\LexModelBuildingServiceClient
Amazon Lex Model Building V2Aws\LexModelsV2\LexModelsV2Client
Amazon Lex Runtime ServiceAws\LexRuntimeService\LexRuntimeServiceClient
Amazon Lex Runtime V2Aws\LexRuntimeV2\LexRuntimeV2Client
AWS License ManagerAws\LicenseManager\LicenseManagerClient
AWS License Manager Linux SubscriptionsAws\LicenseManagerLinuxSubscriptions\LicenseManagerLinuxSubscriptionsClient
AWS License Manager User SubscriptionsAws\LicenseManagerUserSubscriptions\LicenseManagerUserSubscriptionsClient
Amazon LightsailAws\Lightsail\LightsailClient
Amazon Location ServiceAws\LocationService\LocationServiceClient
Amazon Lookout for EquipmentAws\LookoutEquipment\LookoutEquipmentClient
Amazon Lookout for VisionAws\LookoutforVision\LookoutforVisionClient
Amazon Lookout for MetricsAws\LookoutMetrics\LookoutMetricsClient
Amazon Machine LearningAws\MachineLearning\MachineLearningClient
Amazon Macie 2Aws\Macie2\Macie2Client
MailManagerAws\MailManager\MailManagerClient
AWSMainframeModernizationAws\MainframeModernization\MainframeModernizationClient
Amazon Managed BlockchainAws\ManagedBlockchain\ManagedBlockchainClient
Amazon Managed Blockchain QueryAws\ManagedBlockchainQuery\ManagedBlockchainQueryClient
Amazon Managed GrafanaAws\ManagedGrafana\ManagedGrafanaClient
AWS Marketplace Agreement ServiceAws\MarketplaceAgreement\MarketplaceAgreementClient
AWS Marketplace Catalog ServiceAws\MarketplaceCatalog\MarketplaceCatalogClient
AWS Marketplace Commerce AnalyticsAws\MarketplaceCommerceAnalytics\MarketplaceCommerceAnalyticsClient
AWS Marketplace Deployment ServiceAws\MarketplaceDeployment\MarketplaceDeploymentClient
AWS Marketplace Entitlement ServiceAws\MarketplaceEntitlementService\MarketplaceEntitlementServiceClient
AWSMarketplace MeteringAws\MarketplaceMetering\MarketplaceMeteringClient
AWS Marketplace Reporting ServiceAws\MarketplaceReporting\MarketplaceReportingClient
AWS MediaConnectAws\MediaConnect\MediaConnectClient
AWS Elemental MediaConvertAws\MediaConvert\MediaConvertClient
AWS Elemental MediaLiveAws\MediaLive\MediaLiveClient
AWS Elemental MediaPackageAws\MediaPackage\MediaPackageClient
AWS Elemental MediaPackage v2Aws\MediaPackageV2\MediaPackageV2Client
AWS Elemental MediaPackage VODAws\MediaPackageVod\MediaPackageVodClient
AWS Elemental MediaStoreAws\MediaStore\MediaStoreClient
AWS Elemental MediaStore Data PlaneAws\MediaStoreData\MediaStoreDataClient
AWS MediaTailorAws\MediaTailor\MediaTailorClient
AWS Health ImagingAws\MedicalImaging\MedicalImagingClient
Amazon MemoryDBAws\MemoryDB\MemoryDBClient
Application Migration ServiceAws\mgn\mgnClient
AWS Migration HubAws\MigrationHub\MigrationHubClient
AWS Migration Hub ConfigAws\MigrationHubConfig\MigrationHubConfigClient
AWS Migration Hub OrchestratorAws\MigrationHubOrchestrator\MigrationHubOrchestratorClient
AWS Migration Hub Refactor SpacesAws\MigrationHubRefactorSpaces\MigrationHubRefactorSpacesClient
Migration Hub Strategy RecommendationsAws\MigrationHubStrategyRecommendations\MigrationHubStrategyRecommendationsClient
AmazonMQAws\MQ\MQClient
Amazon Mechanical TurkAws\MTurk\MTurkClient
AmazonMWAAAws\MWAA\MWAAClient
Amazon NeptuneAws\Neptune\NeptuneClient
Amazon NeptuneDataAws\Neptunedata\NeptunedataClient
Amazon Neptune GraphAws\NeptuneGraph\NeptuneGraphClient
AWS Network FirewallAws\NetworkFirewall\NetworkFirewallClient
AWS Network ManagerAws\NetworkManager\NetworkManagerClient
Amazon CloudWatch Network MonitorAws\NetworkMonitor\NetworkMonitorClient
CloudWatch Observability Access ManagerAws\OAM\OAMClient
Amazon OmicsAws\Omics\OmicsClient
OpenSearch Service ServerlessAws\OpenSearchServerless\OpenSearchServerlessClient
Amazon OpenSearch ServiceAws\OpenSearchService\OpenSearchServiceClient
AWS OpsWorksAws\OpsWorks\OpsWorksClient
AWS OpsWorks CMAws\OpsWorksCM\OpsWorksCMClient
AWS OrganizationsAws\Organizations\OrganizationsClient
Amazon OpenSearch IngestionAws\OSIS\OSISClient
AWS OutpostsAws\Outposts\OutpostsClient
AWS PanoramaAws\Panorama\PanoramaClient
Payment Cryptography Control PlaneAws\PaymentCryptography\PaymentCryptographyClient
Payment Cryptography Data PlaneAws\PaymentCryptographyData\PaymentCryptographyDataClient
PcaConnectorAdAws\PcaConnectorAd\PcaConnectorAdClient
Private CA Connector for SCEPAws\PcaConnectorScep\PcaConnectorScepClient
AWS Parallel Computing ServiceAws\PCS\PCSClient
Amazon PersonalizeAws\Personalize\PersonalizeClient
Amazon Personalize EventsAws\PersonalizeEvents\PersonalizeEventsClient
Amazon Personalize RuntimeAws\PersonalizeRuntime\PersonalizeRuntimeClient
AWS Performance InsightsAws\PI\PIClient
Amazon PinpointAws\Pinpoint\PinpointClient
Amazon Pinpoint Email ServiceAws\PinpointEmail\PinpointEmailClient
Amazon Pinpoint SMS and Voice ServiceAws\PinpointSMSVoice\PinpointSMSVoiceClient
Amazon Pinpoint SMS Voice V2Aws\PinpointSMSVoiceV2\PinpointSMSVoiceV2Client
Amazon EventBridge PipesAws\Pipes\PipesClient
Amazon PollyAws\Polly\PollyClient
AWS Price List ServiceAws\Pricing\PricingClient
AWS Private 5GAws\PrivateNetworks\PrivateNetworksClient
Amazon Prometheus ServiceAws\PrometheusService\PrometheusServiceClient
AWS ProtonAws\Proton\ProtonClient
QAppsAws\QApps\QAppsClient
QBusinessAws\QBusiness\QBusinessClient
Amazon Q ConnectAws\QConnect\QConnectClient
Amazon QLDBAws\QLDB\QLDBClient
Amazon QLDB SessionAws\QLDBSession\QLDBSessionClient
Amazon QuickSightAws\QuickSight\QuickSightClient
AWS Resource Access ManagerAws\RAM\RAMClient
Amazon Relational Database ServiceAws\Rds\RdsClient
AWS RDS DataServiceAws\RDSDataService\RDSDataServiceClient
Amazon Recycle BinAws\RecycleBin\RecycleBinClient
Amazon RedshiftAws\Redshift\RedshiftClient
Redshift Data API ServiceAws\RedshiftDataAPIService\RedshiftDataAPIServiceClient
Redshift ServerlessAws\RedshiftServerless\RedshiftServerlessClient
Amazon RekognitionAws\Rekognition\RekognitionClient
AWS re:Post PrivateAws\Repostspace\RepostspaceClient
AWS Resilience HubAws\ResilienceHub\ResilienceHubClient
AWS Resource ExplorerAws\ResourceExplorer2\ResourceExplorer2Client
AWS Resource GroupsAws\ResourceGroups\ResourceGroupsClient
AWS Resource Groups Tagging APIAws\ResourceGroupsTaggingAPI\ResourceGroupsTaggingAPIClient
AWS RoboMakerAws\RoboMaker\RoboMakerClient
IAM Roles AnywhereAws\RolesAnywhere\RolesAnywhereClient
Amazon Route 53Aws\Route53\Route53Client
Amazon Route 53 DomainsAws\Route53Domains\Route53DomainsClient
Route 53 ProfilesAws\Route53Profiles\Route53ProfilesClient
Route53 Recovery ClusterAws\Route53RecoveryCluster\Route53RecoveryClusterClient
AWS Route53 Recovery Control ConfigAws\Route53RecoveryControlConfig\Route53RecoveryControlConfigClient
AWS Route53 Recovery ReadinessAws\Route53RecoveryReadiness\Route53RecoveryReadinessClient
Amazon Route 53 ResolverAws\Route53Resolver\Route53ResolverClient
Amazon Simple Storage ServiceAws\S3\S3Client
AWS S3 ControlAws\S3Control\S3ControlClient
Amazon S3 on OutpostsAws\S3Outposts\S3OutpostsClient
Amazon SageMaker ServiceAws\SageMaker\SageMakerClient
Amazon Sagemaker Edge ManagerAws\SagemakerEdgeManager\SagemakerEdgeManagerClient
Amazon SageMaker Feature Store RuntimeAws\SageMakerFeatureStoreRuntime\SageMakerFeatureStoreRuntimeClient
Amazon SageMaker geospatial capabilitiesAws\SageMakerGeospatial\SageMakerGeospatialClient
Amazon SageMaker Metrics ServiceAws\SageMakerMetrics\SageMakerMetricsClient
Amazon SageMaker RuntimeAws\SageMakerRuntime\SageMakerRuntimeClient
AWS Savings PlansAws\SavingsPlans\SavingsPlansClient
Amazon EventBridge SchedulerAws\Scheduler\SchedulerClient
SchemasAws\Schemas\SchemasClient
AWS Secrets ManagerAws\SecretsManager\SecretsManagerClient
AWS SecurityHubAws\SecurityHub\SecurityHubClient
Amazon Security LakeAws\SecurityLake\SecurityLakeClient
AWSServerlessApplicationRepositoryAws\ServerlessApplicationRepository\ServerlessApplicationRepositoryClient
AWS Service CatalogAws\ServiceCatalog\ServiceCatalogClient
AWS Cloud MapAws\ServiceDiscovery\ServiceDiscoveryClient
Service QuotasAws\ServiceQuotas\ServiceQuotasClient
Amazon Simple Email ServiceAws\Ses\SesClient
Amazon Simple Email ServiceAws\SesV2\SesV2Client
AWS Step FunctionsAws\Sfn\SfnClient
AWS ShieldAws\Shield\ShieldClient
AWS SignerAws\signer\signerClient
AWS SimSpace WeaverAws\SimSpaceWeaver\SimSpaceWeaverClient
AWS Server Migration ServiceAws\Sms\SmsClient
Amazon Import/Export SnowballAws\SnowBall\SnowBallClient
AWS Snow Device ManagementAws\SnowDeviceManagement\SnowDeviceManagementClient
Amazon Simple Notification ServiceAws\Sns\SnsClient
AWS End User Messaging SocialAws\SocialMessaging\SocialMessagingClient
Amazon Simple Queue ServiceAws\Sqs\SqsClient
Amazon Simple Systems Manager (SSM)Aws\Ssm\SsmClient
AWS Systems Manager Incident Manager ContactsAws\SSMContacts\SSMContactsClient
AWS Systems Manager Incident ManagerAws\SSMIncidents\SSMIncidentsClient
AWS Systems Manager QuickSetupAws\SSMQuickSetup\SSMQuickSetupClient
AWS Systems Manager for SAPAws\SsmSap\SsmSapClient
AWS Single Sign-OnAws\SSO\SSOClient
AWS Single Sign-On AdminAws\SSOAdmin\SSOAdminClient
AWS SSO OIDCAws\SSOOIDC\SSOOIDCClient
AWS Storage GatewayAws\StorageGateway\StorageGatewayClient
AWS Security Token ServiceAws\Sts\StsClient
AWS Supply ChainAws\SupplyChain\SupplyChainClient
AWS SupportAws\Support\SupportClient
AWS Support AppAws\SupportApp\SupportAppClient
Amazon Simple Workflow ServiceAws\Swf\SwfClient
SyntheticsAws\Synthetics\SyntheticsClient
Tax SettingsAws\TaxSettings\TaxSettingsClient
Amazon TextractAws\Textract\TextractClient
Timestream InfluxDBAws\TimestreamInfluxDB\TimestreamInfluxDBClient
Amazon Timestream QueryAws\TimestreamQuery\TimestreamQueryClient
Amazon Timestream WriteAws\TimestreamWrite\TimestreamWriteClient
AWS Telco Network BuilderAws\Tnb\TnbClient
Amazon Transcribe ServiceAws\TranscribeService\TranscribeServiceClient
AWS Transfer FamilyAws\Transfer\TransferClient
Amazon TranslateAws\Translate\TranslateClient
TrustedAdvisor Public APIAws\TrustedAdvisor\TrustedAdvisorClient
Amazon Verified PermissionsAws\VerifiedPermissions\VerifiedPermissionsClient
Amazon Voice IDAws\VoiceID\VoiceIDClient
Amazon VPC LatticeAws\VPCLattice\VPCLatticeClient
AWS WAFAws\Waf\WafClient
AWS WAF RegionalAws\WafRegional\WafRegionalClient
AWS WAFV2Aws\WAFV2\WAFV2Client
AWS Well-Architected ToolAws\WellArchitected\WellArchitectedClient
Amazon WorkDocsAws\WorkDocs\WorkDocsClient
Amazon WorkMailAws\WorkMail\WorkMailClient
Amazon WorkMail Message FlowAws\WorkMailMessageFlow\WorkMailMessageFlowClient
Amazon WorkSpacesAws\WorkSpaces\WorkSpacesClient
Amazon WorkSpaces Thin ClientAws\WorkSpacesThinClient\WorkSpacesThinClientClient
Amazon WorkSpaces WebAws\WorkSpacesWeb\WorkSpacesWebClient
AWS X-RayAws\XRay\XRayClient

Table of Contents

Namespaces

AccessAnalyzer
Account
Acm
ACMPCA
Amplify
AmplifyBackend
AmplifyUIBuilder
Api
ApiGateway
ApiGatewayManagementApi
ApiGatewayV2
AppConfig
AppConfigData
AppFabric
Appflow
AppIntegrationsService
ApplicationAutoScaling
ApplicationCostProfiler
ApplicationDiscoveryService
ApplicationInsights
ApplicationSignals
AppMesh
AppRegistry
AppRunner
Appstream
AppSync
AppTest
ARCZonalShift
Arn
Artifact
Athena
AuditManager
AugmentedAIRuntime
Auth
AutoScaling
AutoScalingPlans
B2bi
Backup
BackupGateway
Batch
BCMDataExports
Bedrock
BedrockAgent
BedrockAgentRuntime
BedrockRuntime
BillingConductor
Braket
Budgets
Chatbot
Chime
ChimeSDKIdentity
ChimeSDKMediaPipelines
ChimeSDKMeetings
ChimeSDKMessaging
ChimeSDKVoice
CleanRooms
CleanRoomsML
ClientSideMonitoring
Cloud9
CloudControlApi
CloudDirectory
CloudFormation
CloudFront
CloudFrontKeyValueStore
CloudHsm
CloudHSMV2
CloudSearch
CloudSearchDomain
CloudTrail
CloudTrailData
CloudWatch
CloudWatchEvents
CloudWatchEvidently
CloudWatchLogs
CloudWatchRUM
CodeArtifact
CodeBuild
CodeCatalyst
CodeCommit
CodeConnections
CodeDeploy
CodeGuruProfiler
CodeGuruReviewer
CodeGuruSecurity
CodePipeline
CodeStarconnections
CodeStarNotifications
CognitoIdentity
CognitoIdentityProvider
CognitoSync
Comprehend
ComprehendMedical
ComputeOptimizer
ConfigService
Configuration
Connect
ConnectCampaignService
ConnectCases
ConnectContactLens
ConnectParticipant
ConnectWisdomService
ControlCatalog
ControlTower
CostandUsageReportService
CostExplorer
CostOptimizationHub
Credentials
Crypto
CustomerProfiles
DatabaseMigrationService
DataExchange
DataPipeline
DataSync
DataZone
DAX
Deadline
DefaultsMode
Detective
DeviceFarm
DevOpsGuru
DirectConnect
DirectoryService
DirectoryServiceData
DLM
DocDB
DocDBElastic
drs
DynamoDb
DynamoDbStreams
EBS
Ec2
EC2InstanceConnect
Ecr
ECRPublic
Ecs
Efs
EKS
EKSAuth
ElastiCache
ElasticBeanstalk
ElasticInference
ElasticLoadBalancing
ElasticLoadBalancingV2
ElasticsearchService
ElasticTranscoder
Emr
EMRContainers
EMRServerless
Endpoint
EndpointDiscovery
EndpointV2
EntityResolution
EventBridge
Exception
finspace
FinSpaceData
Firehose
FIS
FMS
ForecastQueryService
ForecastService
FraudDetector
FreeTier
FSx
GameLift
GeoMaps
GeoPlaces
GeoRoutes
Glacier
GlobalAccelerator
Glue
GlueDataBrew
Greengrass
GreengrassV2
GroundStation
GuardDuty
Handler
Health
HealthLake
Iam
Identity
IdentityStore
imagebuilder
ImportExport
Inspector
Inspector2
InspectorScan
InternetMonitor
Iot
IoT1ClickDevicesService
IoT1ClickProjects
IoTAnalytics
IotDataPlane
IoTDeviceAdvisor
IoTEvents
IoTEventsData
IoTFleetHub
IoTFleetWise
IoTJobsDataPlane
IoTSecureTunneling
IoTSiteWise
IoTThingsGraph
IoTTwinMaker
IoTWireless
IVS
ivschat
IVSRealTime
Kafka
KafkaConnect
kendra
KendraRanking
Keyspaces
Kinesis
KinesisAnalytics
KinesisAnalyticsV2
KinesisVideo
KinesisVideoArchivedMedia
KinesisVideoMedia
KinesisVideoSignalingChannels
KinesisVideoWebRTCStorage
Kms
LakeFormation
Lambda
LaunchWizard
LexModelBuildingService
LexModelsV2
LexRuntimeService
LexRuntimeV2
LicenseManager
LicenseManagerLinuxSubscriptions
LicenseManagerUserSubscriptions
Lightsail
LocationService
LookoutEquipment
LookoutforVision
LookoutMetrics
MachineLearning
Macie2
MailManager
MainframeModernization
ManagedBlockchain
ManagedBlockchainQuery
ManagedGrafana
MarketplaceAgreement
MarketplaceCatalog
MarketplaceCommerceAnalytics
MarketplaceDeployment
MarketplaceEntitlementService
MarketplaceMetering
MarketplaceReporting
MediaConnect
MediaConvert
MediaLive
MediaPackage
MediaPackageV2
MediaPackageVod
MediaStore
MediaStoreData
MediaTailor
MedicalImaging
MemoryDB
mgn
MigrationHub
MigrationHubConfig
MigrationHubOrchestrator
MigrationHubRefactorSpaces
MigrationHubStrategyRecommendations
MQ
MTurk
Multipart
MWAA
Neptune
Neptunedata
NeptuneGraph
NetworkFirewall
NetworkManager
NetworkMonitor
OAM
Omics
OpenSearchServerless
OpenSearchService
OpsWorks
OpsWorksCM
Organizations
OSIS
Outposts
Panorama
PaymentCryptography
PaymentCryptographyData
PcaConnectorAd
PcaConnectorScep
PCS
Personalize
PersonalizeEvents
PersonalizeRuntime
PI
Pinpoint
PinpointEmail
PinpointSMSVoice
PinpointSMSVoiceV2
Pipes
Polly
Pricing
PrivateNetworks
PrometheusService
Proton
QApps
QBusiness
QConnect
QLDB
QLDBSession
QuickSight
RAM
Rds
RDSDataService
RecycleBin
Redshift
RedshiftDataAPIService
RedshiftServerless
Rekognition
Repostspace
ResilienceHub
ResourceExplorer2
ResourceGroups
ResourceGroupsTaggingAPI
Retry
RoboMaker
RolesAnywhere
Route53
Route53Domains
Route53Profiles
Route53RecoveryCluster
Route53RecoveryControlConfig
Route53RecoveryReadiness
Route53Resolver
S3
S3Control
S3Outposts
SageMaker
SagemakerEdgeManager
SageMakerFeatureStoreRuntime
SageMakerGeospatial
SageMakerMetrics
SageMakerRuntime
SavingsPlans
Scheduler
Schemas
Script
SecretsManager
SecurityHub
SecurityLake
ServerlessApplicationRepository
ServiceCatalog
ServiceDiscovery
ServiceQuotas
Ses
SesV2
Sfn
Shield
Signature
signer
SimSpaceWeaver
Sms
SnowBall
SnowDeviceManagement
Sns
SocialMessaging
Sqs
Ssm
SSMContacts
SSMIncidents
SSMQuickSetup
SsmSap
SSO
SSOAdmin
SSOOIDC
StorageGateway
Sts
SupplyChain
Support
SupportApp
Swf
Synthetics
TaxSettings
Textract
TimestreamInfluxDB
TimestreamQuery
TimestreamWrite
Tnb
Token
TranscribeService
Transfer
Translate
TrustedAdvisor
VerifiedPermissions
VoiceID
VPCLattice
Waf
WafRegional
WAFV2
WellArchitected
WorkDocs
WorkMail
WorkMailMessageFlow
WorkSpaces
WorkSpacesThinClient
WorkSpacesWeb
XRay

Interfaces

AwsClientInterface
Represents an AWS client.
CacheInterface
Represents a simple cache interface.
CommandInterface
A command object encapsulates the input parameters used to control the creation of a HTTP request and processing of a HTTP response.
ConfigurationProviderInterface
HashInterface
Interface that allows implementing various incremental hashes.
MonitoringEventsInterface
Interface for adding and retrieving client-side monitoring events
ResponseContainerInterface
ResultInterface
Represents an AWS result object that is returned from executing an operation.

Classes

AbstractConfigurationProvider
A configuration provider is a function that returns a promise that is fulfilled with a configuration object. This class provides base functionality usable by specific configuration provider implementations
AwsClient
Default AWS client implementation
Command
AWS command object.
CommandPool
Sends and iterator of commands concurrently using a capped pool size.
DoctrineCacheAdapter
HandlerList
Builds a single handler function from zero or more middleware functions and a handler. The handler function is then used to send command objects and return a promise that is resolved with an AWS result object.
HashingStream
Stream decorator that calculates a rolling hash of the stream as it is read.
History
Represents a history container that is required when using the history middleware.
LruArrayCache
Simple in-memory LRU cache that limits the number of cached entries.
Middleware
MockHandler
Returns promises that are rejected or fulfilled using a queue of Aws\ResultInterface and Aws\Exception\AwsException objects.
MultiRegionClient
PhpHash
Incremental hashing using PHP's hash functions.
Psr16CacheAdapter
PsrCacheAdapter
Result
AWS result.
ResultPaginator
Iterator that yields each page of results of a pageable operation.
Sdk
Builds AWS clients based on configuration settings.
TraceMiddleware
Traces state changes between middlewares.
Waiter
"Waiters" are associated with an AWS resource (e.g., EC2 instance), and poll that resource and until it is in a particular state.
WrappedHttpHandler
Converts an HTTP handler into a Command HTTP handler.

Traits

AwsClientTrait
A trait providing generic functionality for interacting with Amazon Web Services. This is meant to be used in classes implementing \Aws\AwsClientInterface
HasDataTrait
Trait implementing ToArrayInterface, \ArrayAccess, \Countable, and \IteratorAggregate
HasMonitoringEventsTrait

Functions

constantly()  : callable
Returns a function that always returns the same value;
filter()  : Generator
Filters values that do not satisfy the predicate function $pred.
map()  : Generator
Applies a map function $f to each value in a collection.
flatmap()  : Generator
Creates a generator that iterates over a sequence, then iterates over each value in the sequence and yields the application of the map function to each value.
partition()  : Generator
Partitions the input sequence into partitions of the specified size.
or_chain()  : callable
Returns a function that invokes the provided variadic functions one after the other until one of the functions returns a non-null value.
load_compiled_json()  : mixed
Loads a compiled JSON file from a PHP file.
clear_compiled_json()  : mixed
No-op
dir_iterator()  : Generator
Iterates over the files in a directory and works with custom wrappers.
recursive_dir_iterator()  : Generator
Returns a recursive directory iterator that yields absolute filenames.
describe_type()  : string
Debug function used to describe the provided value type and class.
default_http_handler()  : callable
Creates a default HTTP handler based on the available clients.
default_user_agent()  : string
Gets the default user agent string depending on the Guzzle version
serialize()  : RequestInterface
Serialize a request for a command but do not send it.
manifest()  : array<string|int, mixed>
Retrieves data for a service from the SDK's service manifest file.
is_valid_hostname()  : bool
Checks if supplied parameter is a valid hostname
is_valid_hostlabel()  : bool
Checks if supplied parameter is a valid host label
parse_ini_file()  : array<string|int, mixed>|bool
Ignores '#' full line comments, which parse_ini_file no longer does in PHP 7+.
boolean_value()  : bool|null
Outputs boolean value of input for a select range of possible values, null otherwise
parse_ini_section_with_subsections()  : array<string|int, mixed>
Parses ini sections with subsections (i.e. the service section)
is_valid_epoch()  : bool
Checks if an input is a valid epoch time
is_fips_pseudo_region()  : bool
Checks if an input is a fips pseudo region
strip_fips_pseudo_regions()  : string
Returns a region without a fips label
is_associative()  : bool
Checks if an array is associative