This API documentation for the AWS SDK for PHP contains documentation
for 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.
This client is used to interact with the AWS Certificate Manager service.
This client is used to interact with the AWS Certificate Manager Private Certificate Authority service.
This client is used to interact with the Alexa For Business service.
Base class that is used by most API shapes
DateTime overrides that make DateTime work more seamlessly as a string,
with JSON documents, and with JMESPath.
Encapsulates the documentation strings for a given service-version and
provides methods for extracting the desired parts related to a service,
operation, error, or shape (i.e., parameter).
Represents an API operation.
Represents a web service API model.
Base class representing a modeled shape.
Builds shape based on shape references.
Represents a structure shape and resolve member shape references.
Represents a timestamp shape.
Validates a schema against a hash of input.
This client is used to interact with the AWS API Gateway service.
This client is used to interact with the Application Auto Scaling service.
This client is used to interact with the AWS Application Discovery Service service.
This client is used to interact with the Amazon AppStream service.
This client is used to interact with the AWS AppSync service.
This client is used to interact with the Amazon Athena service.
This client is used to interact with the AWS Auto Scaling Plans service.
Default AWS client implementation
This client is used to interact with the AWS Batch service.
This client is used to interact with the AWS Budgets service.
This client is used to interact with the AWS Cloud9 service.
This client is used to interact with the Amazon CloudDirectory service.
This client is used to interact with the AWS CloudFormation service.
This client is used to interact with the Amazon CloudFront service.
Creates signed URLs for Amazon CloudFront resources.
This client is used to interact with AWS CloudHSM.
This client is used to interact with the AWS CloudHSM V2 service.
This client is used to interact with the Amazon CloudSearch service.
This client is used to search and upload documents to an Amazon CloudSearch Domain.
This client is used to interact with the AWS CloudTrail service.
The Aws\CloudTrail\LogFileIterator provides an easy way to iterate over
log file generated by AWS CloudTrail.
This class provides an easy way to read log files generated by AWS
CloudTrail.
The Aws\CloudTrail\LogRecordIterator provides an easy way to iterate over
log records from log files generated by AWS CloudTrail.
This client is used to interact with the Amazon CloudWatch service.
This client is used to interact with the Amazon CloudWatch Events service.
This client is used to interact with the Amazon CloudWatch Logs service.
This client is used to interact with the AWS CodeBuild service.
This client is used to interact with the AWS CodeCommit service.
This client is used to interact with AWS CodeDeploy
This client is used to interact with the Amazon CodePipeline service.
This client is used to interact with the AWS CodeStar service.
This client is used to interact with the Amazon Cognito Identity service.
This client is used to interact with the Amazon Cognito Identity Provider service.
This client is used to interact with the Amazon Cognito Sync service.
Sends and iterator of commands concurrently using a capped pool size.
This client is used to interact with the Amazon Comprehend service.
This client is used to interact with AWS Config.
This client is used to interact with the Amazon Connect Service service.
This client is used to interact with the AWS Cost and Usage Report Service service.
This client is used to interact with the AWS Cost Explorer Service service.
Credential provider that provides credentials via assuming a role
More Information, see: http://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sts-2011-06-15.html#assumerole
Basic implementation of the AWS Credentials interface that allows callers to
pass in the AWS Access Key and AWS Secret Access Key in the constructor.
Credential provider that fetches credentials with GET request.
ECS environment variable is used in constructing request URI.
Credential provider that provides credentials from the EC2 metadata server.
An implementation of the CBC cipher for use with an AesEncryptingStream or
AesDecrypting stream.
Uses KMS to supply materials for encrypting and decrypting data.
This client is used to interact with the AWS Database Migration Service service.
This client is used to interact with the AWS Data Pipeline service.
This client is used to interact with the Amazon DynamoDB Accelerator (DAX) service.
This client is used to interact with the Amazon DeviceFarm service.
This client is used to interact with the AWS Direct Connect service.
AWS Directory Service client
Represents a simple cache interface.
Special object to represent a DynamoDB binary (B) value.
This client is used to interact with the Amazon DynamoDB service.
The locking connection adds locking logic to the read operation.
Marshals and unmarshals JSON documents and PHP arrays into DynamoDB items.
Special object to represent a DynamoDB Number (N) value.
Provides an interface for using Amazon DynamoDB as a session store by hooking
into PHP's session handler hooks. Once registered, You may use the native
$_SESSION superglobal and session functions, and the sessions will be
stored automatically in DynamoDB. DynamoDB is a great session storage
solution due to its speed, scalability, and fault tolerance.
Special object to represent a DynamoDB set (SS/NS/BS) value.
The standard connection performs the read and write operations to DynamoDB.
The WriteRequestBatch is an object that is capable of efficiently sending
DynamoDB BatchWriteItem requests from queued up put and delete item requests.
requests. The batch attempts to send the requests with the fewest requests
to DynamoDB as possible and also re-queues any unprocessed items to ensure
that all items are sent.
This client is used to interact with the Amazon DynamoDb Streams service.
Client used to interact with Amazon EC2.
This client is used to interact with the Amazon EC2 Container Registry service.
This client is used to interact with Amazon ECS.
This client is used to interact with Amazon EFS.
This client is used to interact with the Amazon Elastic Container Service for Kubernetes service.
This client is used to interact with the Amazon ElastiCache service.
This client is used to interact with the AWS Elastic Beanstalk service.
This client is used to interact with the Elastic Load Balancing service.
This client is used to interact with the Elastic Load Balancing service.
This client is used to interact with the Amazon Elasticsearch Service service.
This client is used to interact with the Amazon Elastic Transcoder service.
This client is used to interact with the Amazon Elastic MapReduce (Amazon EMR) service.
Default implementation of an AWS partition.
Provides endpoints based on an endpoint pattern configuration array.
This client is used to interact with the Amazon Kinesis Firehose service.
This client is used to interact with the Firewall Management Service service.
This client is used to interact with the Amazon GameLift service.
This client is used to interact with the Amazon Glacier service.
Encapsulates the execution of a multipart upload to Glacier.
Encapsulates the creation of a tree hash from streamed data
This client is used to interact with the AWS Glue service.
This client is used to interact with the AWS Greengrass service.
This client is used to interact with the Amazon GuardDuty service.
A request handler that sends PSR-7-compatible requests with Guzzle 5.
Adapts a PSR-7 Stream to a Guzzle 5 Stream.
Adapts a Guzzle 5 Stream to a PSR-7 Stream.
A request handler that sends PSR-7-compatible requests with Guzzle 6.
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.
Stream decorator that calculates a rolling hash of the stream as it is read.
This client is used to interact with the AWS Health APIs and Notifications service.
Represents a history container that is required when using the history
middleware.
This client is used to interact with the AWS Identity and Access Management (AWS IAM) service.
This client is used to interact with the AWS Import/Export service.
This client is used to interact with the Amazon Inspector service.
This client is used to interact with the AWS IoT 1-Click Devices Service service.
This client is used to interact with the AWS IoT 1-Click Projects Service service.
This client is used to interact with the AWS IoT service.
This client is used to interact with the AWS IoT Analytics service.
This client is used to interact with the AWS IoT Data Plane service.
This client is used to interact with the AWS IoT Jobs Data Plane service.
Loads JSON files and compiles them into PHP arrays.
This client is used to interact with the Amazon Kinesis service.
This client is used to interact with the Amazon Kinesis Analytics service.
This client is used to interact with the Amazon Kinesis Video Streams service.
This client is used to interact with the Amazon Kinesis Video Streams Archived Media service.
This client is used to interact with the Amazon Kinesis Video Streams Media service.
This client is used to interact with the AWS Key Management Service.
This client is used to interact with AWS Lambda
This client is used to interact with the Amazon Lex Model Building Service service.
This client is used to interact with the Amazon Lex Runtime Service service.
This client is used to interact with the Amazon Lightsail service.
Simple in-memory LRU cache that limits the number of cached entries.
Amazon Machine Learning client.
This client is used to interact with the AWS Marketplace Commerce Analytics service.
This client is used to interact with the AWS Marketplace Entitlement Service service.
This client is used to interact with the AWSMarketplace Metering service.
This client is used to interact with the AWS Elemental MediaConvert service.
This client is used to interact with the AWS Elemental MediaLive service.
This client is used to interact with the AWS Elemental MediaPackage service.
This client is used to interact with the AWS Elemental MediaStore service.
This client is used to interact with the AWS Elemental MediaStore Data Plane service.
This client is used to interact with the AWS MediaTailor service.
This client is used to interact with the AWS Migration Hub service.
This client is used to interact with the AWS Mobile service.
Returns promises that are rejected or fulfilled using a queue of
Aws\ResultInterface and Aws\Exception\AwsException objects.
This client is used to interact with the AmazonMQ service.
This client is used to interact with the Amazon Mechanical Turk Requester Service service.
Representation of the multipart upload.
Represents an AWS client.
This client is used to interact with the Amazon Neptune service.
This client is used to interact with the AWS OpsWorks service.
This client is used to interact with the AWS OpsWorks for Chef Automate service.
This client is used to interact with the AWS Organizations service.
Incremental hashing using PHP's hash functions.
This client is used to interact with the AWS Performance Insights service.
This client is used to interact with the Amazon Pinpoint service.
This client is used to interact with the Amazon Polly service.
This client is used to interact with the AWS Price List Service service.
Represents a simple cache interface.
Generates RDS auth tokens for use with IAM authentication.
This client is used to interact with the Amazon Relational Database Service (Amazon RDS).
This client is used to interact with the Amazon Redshift service.
This client is used to interact with the Amazon Rekognition service.
This client is used to interact with the AWS Resource Groups service.
This client is used to interact with the AWS Resource Groups Tagging API service.
Iterator that yields each page of results of a pageable operation.
This client is used to interact with the Amazon Route 53 service.
This client is used to interact with the Amazon Route 53 Domains service.
Efficiently deletes many objects from a single Amazon S3 bucket using an
iterator that yields keys. Deletes are made using the DeleteObjects API
operation.
Stores and reads encryption MetadataEnvelope information in a file on Amazon
S3.
Provides a wrapper for an S3Client that supplies functionality to encrypt
data on putObject[Async] calls and decrypt data on getObject[Async] calls.
Encapsulates the execution of a multipart upload of an encrypted object to S3.
Encapsulates the execution of a multipart upload to S3 or Glacier.
Copies objects from one S3 location to another, utilizing a multipart copy
when appropriate.
Uploads an object to S3, using a PutObject command or a multipart upload as
appropriate.
Encapsulates the logic for getting the data for an S3 object POST upload form
Client used to interact with Amazon Simple Storage Service (Amazon S3).
Amazon Simple Storage Service multi-region client.
Extracts a region, bucket, key, and and if a URI is in path-style
Amazon S3 stream wrapper to use "s3:///" files with PHP
streams, supporting "r", "w", "a", "x".
Transfers files from the local filesystem to S3 or from S3 to the local
filesystem.
This client is used to interact with the Amazon SageMaker Service service.
This client is used to interact with the Amazon SageMaker Runtime service.
Builds AWS clients based on configuration settings.
This client is used to interact with the AWS Secrets Manager service.
This client is used to interact with the AWSServerlessApplicationRepository service.
This client is used to interact with the AWS Service Catalog service.
This client is used to interact with the Amazon Route 53 Auto Naming service.
This client is used to interact with the Amazon Simple Email Service (Amazon SES).
This client is used to interact with the AWS Step Functions service.
This client is used to interact with the AWS Shield service.
Provides anonymous client access (does not sign requests).
Amazon S3 signature version 4 support.
This client is used to interact with the AWS Server Migration Service service.
This client is used to interact with the Amazon Import/Export Snowball service.
Represents an SNS message received over http(s).
Uses openssl to verify SNS messages to ensure that they were sent by AWS.
This client is used to interact with the Amazon Simple Notification Service (Amazon SNS).
Client used to interact Amazon Simple Queue Service (Amazon SQS)
Amazon EC2 Simple Systems Manager client.
AWS Storage Gateway client.
This client is used to interact with the AWS Security Token Service (AWS STS).
Amazon Simple Workflow Service (Amazon SWF) client.
Traces state changes between middlewares.
This client is used to interact with the Amazon Transcribe Service service.
This client is used to interact with the Amazon Translate service.
This client is used to interact with the AWS WAF service.
This client is used to interact with the AWS WAF Regional service.
"Waiters" are associated with an AWS resource (e.g., EC2 instance), and poll
that resource and until it is in a particular state.
This client is used to interact with the Amazon WorkDocs service.
This client is used to interact with the Amazon WorkMail service.
Amazon WorkSpaces client.
Converts an HTTP handler into a Command HTTP handler.
This client is used to interact with the AWS X-Ray service.
Represents an error interacting with the AWS Certificate Manager service.
Represents an error interacting with the AWS Certificate Manager Private Certificate Authority service.
Represents an error interacting with the Alexa For Business service.
Represents an error interacting with the AWS API Gateway service.
Represents an error interacting with the Application Auto Scaling service.
Represents an error interacting with the AWS Application Discovery Service service.
Represents an error interacting with the Amazon AppStream service.
Represents an error interacting with the AWS AppSync service.
Represents an error interacting with the Amazon Athena service.
Represents an error while interacting with the Auto Scaling service.
Represents an error interacting with the AWS Auto Scaling Plans service.
Represents an error interacting with the AWS Batch service.
Represents an error interacting with the AWS Budgets service.
Represents an error interacting with the AWS Cloud9 service.
Represents an error interacting with the Amazon CloudDirectory service.
Represents an error interacting with the AWS CloudFormation service.
Represents an error interacting with the Amazon CloudFront service.
Represents an error interacting with the AWS CloudHSM V2 service.
Represents an error interacting with the Amazon CloudSearch service.
Represents an error interacting with an Amazon CloudSearch Domain.
Represents an error interacting with the AWS CloudTrail service.
Represents an error interacting with the Amazon CloudWatch service.
Represents an error interacting with the Amazon CloudWatch Events service.
Represents an error interacting with the Amazon CloudWatch Logs service.
Represents an error interacting with the AWS CodeBuild service.
Represents an error interacting with the AWS CodeCommit service.
Represents an error interacting with AWS CodeDeploy.
Represents an error interacting with the Amazon CodePipeline service.
Represents an error interacting with the AWS CodeStar service.
Represents an error interacting with the Amazon Cognito Identity Logs service.
Represents an error interacting with the Amazon Cognito Identity Provider service.
Represents an error interacting with the Amazon Cognito Sync service.
Represents an error interacting with the Amazon Comprehend service.
Represents an error interacting with the AWS Config service.
Represents an error interacting with the Amazon Connect Service service.
Represents an error interacting with the AWS Cost and Usage Report Service service.
Represents an error interacting with the AWS Cost Explorer Service service.
Represents an error interacting with the AWS Database Migration Service service.
Represents an error interacting with the AWS Data Pipeline service.
Represents an error interacting with the Amazon DynamoDB Accelerator (DAX) service.
Represents an error interacting with the Amazon DeviceFarm service.
Represents an error interacting with the AWS Direct Connect service.
AWS Directory Service Exception
Represents an error interacting with the Amazon DynamoDB service.
Represents an error interacting with the Amazon DynamoDB Streams service.
Represents an error interacting with the Amazon Elastic Compute Cloud service.
Represents an error interacting with the Amazon EC2 Container Registry service.
Represents an error interacting with the Amazon Elastic Container Service for Kubernetes service.
Represents an error interacting with the Amazon ElastiCache service.
Represents an error interacting with the AWS Elastic Beanstalk service.
Represents an error interacting with the Elastic Load Balancing service.
Represents an error interacting with the Elastic Load Balancing service.
Represents an error interacting with the Amazon Elasticsearch Service service.
Represents an error interacting with the Amazon Elastic Transcoder service.
Represents an error interacting with the Amazon Elastic MapReduce service.
Represents an AWS exception that is thrown when a command fails.
Represents an error interacting with the Amazon Kinesis Firehose service.
Represents an error interacting with the Firewall Management Service service.
Represents an error interacting with the Amazon GameLift service.
Represents an error interacting with the Amazon Glacier service.
Represents an error interacting with the AWS Glue service.
Represents an error interacting with the AWS Greengrass service.
Represents an error interacting with the Amazon GuardDuty service.
Represents an error interacting with the AWS Health APIs and Notifications service.
Represents an error interacting with the AWS Identity and Access Management service.
Represents an error interacting with the AWS Import/Export service.
Represents an error interacting with the Amazon Inspector service.
Represents an error interacting with the AWS IoT 1-Click Devices Service service.
Represents an error interacting with the AWS IoT 1-Click Projects Service service.
Represents an error interacting with the AWS IoT service.
Represents an error interacting with the AWS IoT Analytics service.
Represents an error interacting with the AWS IoT Data Plane service.
Represents an error interacting with the AWS IoT Jobs Data Plane service.
Represents an error interacting with the Amazon Kinesis service.
Represents an error interacting with the Amazon Kinesis Analytics service.
Represents an error interacting with the Amazon Kinesis Video Streams service.
Represents an error interacting with the Amazon Kinesis Video Streams Archived Media service.
Represents an error interacting with the Amazon Kinesis Video Streams Media service.
Represents an error interacting with the AWS Key Management Service.
Represents an error interacting with AWS Lambda
Represents an error interacting with the Amazon Lex Model Building Service service.
Represents an error interacting with the Amazon Lex Runtime Service service.
Represents an error interacting with the Amazon Lightsail service.
Amazon Machine Learning exception.
Represents an error interacting with the AWS Marketplace Commerce Analytics service.
Represents an error interacting with the AWS Marketplace Entitlement Service service.
Represents an error interacting with the AWSMarketplace Metering service.
Represents an error interacting with the AWS Elemental MediaConvert service.
Represents an error interacting with the AWS Elemental MediaLive service.
Represents an error interacting with the AWS Elemental MediaPackage service.
Represents an error interacting with the AWS Elemental MediaStore service.
Represents an error interacting with the AWS Elemental MediaStore Data Plane service.
Represents an error interacting with the AWS MediaTailor service.
Represents an error interacting with the AWS Migration Hub service.
Represents an error interacting with the AWS Mobile service.
Represents an error interacting with the AmazonMQ service.
Represents an error interacting with the Amazon Mechanical Turk Requester Service service.
Represents an error interacting with the Amazon Neptune service.
Represents an error interacting with the AWS OpsWorks service.
Represents an error interacting with the AWS OpsWorks for Chef Automate service.
Represents an error interacting with the AWS Organizations service.
Represents an error interacting with the AWS Performance Insights service.
Represents an error interacting with the Amazon Pinpoint service.
Represents an error interacting with the Amazon Polly service.
Represents an error interacting with the AWS Price List Service service.
Represents an error interacting with the Amazon Relational Database Service.
Represents an error interacting with the Amazon Redshift service.
Represents an error interacting with the Amazon Rekognition service.
Represents an error interacting with the AWS Resource Groups service.
Represents an error interacting with the AWS Resource Groups Tagging API service.
Represents an error interacting with the Amazon Route 53 service.
Represents an error interacting with the Amazon Route 53 Domains service.
Exception thrown when errors occur while deleting objects using a
S3\BatchDelete object.
Represents an error interacting with the Amazon Simple Storage Service.
Represents an error interacting with the Amazon Simple Storage Service.
Represents an error interacting with the Amazon SageMaker Service service.
Represents an error interacting with the Amazon SageMaker Runtime service.
Represents an error interacting with the AWS Secrets Manager service.
Represents an error interacting with the AWSServerlessApplicationRepository service.
Represents an error interacting with the AWS Service Catalog service.
Represents an error interacting with the Amazon Route 53 Auto Naming service.
Represents an error interacting with the Amazon Simple Email Service.
Represents an error interacting with the AWS Step Functions service.
Represents an error interacting with the AWS Shield service.
Represents an error interacting with the AWS Server Migration Service service.
Represents an error interacting with the Amazon Import/Export Snowball service.
Runtime exception thrown by the SNS Message Validator.
Represents an error interacting with the Amazon Simple Notification Service.
Represents an error interacting with the Amazon Simple Queue Service.
Amazon EC2 Simple Systems Manager exception.
Represents an error interacting with the AWS Storage Gateway service.
AWS Security Token Service exception.
AWS Support service exception.
Represents an error interacting with the Amazon Simple Workflow Service.
Represents an error interacting with the Amazon Transcribe Service service.
Represents an error interacting with the Amazon Translate service.
Represents an error interacting with the AWS WAF service.
Represents an error interacting with the AWS WAF Regional service.
Represents an error interacting with the Amazon WorkDocs service.
Represents an error interacting with the Amazon WorkMail service.
Represents an error while interacting with Amazon WorkSpaces.
Represents an error interacting with the AWS X-Ray service.
