Installation guide
pull request to https://github.com/aws/aws-sdk-php. You can view our documentation sources at
https://github.com/aws/aws-sdk-php/tree/master/docs.
API Reference
Please see the AWS Data Pipeline Client API reference for a details about all of the available methods, including
descriptions of the inputs and outputs.
ActivatePipeline CreatePipeline
DeletePipeline DescribeObjects
DescribePipelines EvaluateExpression
GetPipelineDefinition ListPipelines
PollForTask PutPipelineDefinition
QueryObjects ReportTaskProgress
ReportTaskRunnerHeartbeat SetStatus
SetTaskStatus ValidatePipelineDefinition
AWS Direct Connect
This guide focuses on the AWS SDK for PHP client for AWS Direct Connect. This guide assumes that you have
already downloaded and installed the AWS SDK for PHP. See Installation for more information on getting started.
Creating a client
First you need to create a client object using one of the following techniques.
Factory method
The easiest way to get up and running quickly is to use the
Aws\DirectConnect\DirectConnectClient::factory() method and provide your credentials (key and
secret).
A region parameter is also required and must be set to one of the following values: us-east-1,
ap-northeast-1, sa-east-1, ap-southeast-1, ap-southeast-2, us-west-2, us-west-1, eu-west-1
use Aws\DirectConnect\DirectConnectClient;
$client = DirectConnectClient::factory(array(
'key' => '<aws access key>',
'secret' => '<aws secret key>',
'region' => '<region name>'
));
You can provide your access keys like in the preceding example, or you can choose to omit them if you are using
AWS Identity and Access Management (IAM) roles for EC2 instances or credentials sourced from the
AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables.
Service builder
A more robust way to connect to AWS Direct Connect is through the service builder. This allows you to specify
credentials and other configuration settings in a configuration file. These settings can then be shared across all
clients so that you only have to specify your settings once.
use Aws\Common\Aws;
// Create a service builder using a configuration file
AWS Direct Connect
63