Class AwsClient
- Aws\AwsClient implements Aws\AwsClientInterface uses Aws\AwsClientTrait
- Namespace: Aws
- Located at AwsClient.php
Default AWS client implementation
Direct known subclasses
Aws\Acm\AcmClient,
Aws\ACMPCA\ACMPCAClient,
Aws\AppMesh\AppMeshClient,
Aws\KinesisAnalytics\KinesisAnalyticsClient,
Aws\KinesisAnalyticsV2\KinesisAnalyticsV2Client,
Aws\KinesisVideo\KinesisVideoClient,
Aws\KinesisVideoArchivedMedia\KinesisVideoArchivedMediaClient,
Aws\KinesisVideoMedia\KinesisVideoMediaClient,
Aws\Kms\KmsClient,
Aws\LakeFormation\LakeFormationClient,
Aws\Lambda\LambdaClient,
Aws\LexModelBuildingService\LexModelBuildingServiceClient,
Aws\LexRuntimeService\LexRuntimeServiceClient,
Aws\Appstream\AppstreamClient,
Aws\LicenseManager\LicenseManagerClient,
Aws\Lightsail\LightsailClient,
Aws\MachineLearning\MachineLearningClient,
Aws\Macie\MacieClient,
Aws\ManagedBlockchain\ManagedBlockchainClient,
Aws\MarketplaceCatalog\MarketplaceCatalogClient,
Aws\MarketplaceCommerceAnalytics\MarketplaceCommerceAnalyticsClient,
Aws\MarketplaceEntitlementService\MarketplaceEntitlementServiceClient,
Aws\MarketplaceMetering\MarketplaceMeteringClient,
Aws\MediaConnect\MediaConnectClient,
Aws\AppSync\AppSyncClient,
Aws\MediaConvert\MediaConvertClient,
Aws\MediaLive\MediaLiveClient,
Aws\MediaPackage\MediaPackageClient,
Aws\MediaPackageVod\MediaPackageVodClient,
Aws\MediaStore\MediaStoreClient,
Aws\MediaStoreData\MediaStoreDataClient,
Aws\MediaTailor\MediaTailorClient,
Aws\MigrationHub\MigrationHubClient,
Aws\MigrationHubConfig\MigrationHubConfigClient,
Aws\Mobile\MobileClient,
Aws\Athena\AthenaClient,
Aws\MQ\MQClient,
Aws\MTurk\MTurkClient,
Aws\Neptune\NeptuneClient,
Aws\OpsWorks\OpsWorksClient,
Aws\OpsWorksCM\OpsWorksCMClient,
Aws\Organizations\OrganizationsClient,
Aws\Personalize\PersonalizeClient,
Aws\PersonalizeEvents\PersonalizeEventsClient,
Aws\PersonalizeRuntime\PersonalizeRuntimeClient,
Aws\PI\PIClient,
Aws\AutoScaling\AutoScalingClient,
Aws\Pinpoint\PinpointClient,
Aws\PinpointEmail\PinpointEmailClient,
Aws\PinpointSMSVoice\PinpointSMSVoiceClient,
Aws\Polly\PollyClient,
Aws\Pricing\PricingClient,
Aws\QLDB\QLDBClient,
Aws\QLDBSession\QLDBSessionClient,
Aws\QuickSight\QuickSightClient,
Aws\RAM\RAMClient,
Aws\Rds\RdsClient,
Aws\AutoScalingPlans\AutoScalingPlansClient,
Aws\RDSDataService\RDSDataServiceClient,
Aws\Redshift\RedshiftClient,
Aws\Rekognition\RekognitionClient,
Aws\ResourceGroups\ResourceGroupsClient,
Aws\ResourceGroupsTaggingAPI\ResourceGroupsTaggingAPIClient,
Aws\RoboMaker\RoboMakerClient,
Aws\Route53\Route53Client,
Aws\Route53Domains\Route53DomainsClient,
Aws\Route53Resolver\Route53ResolverClient,
Aws\S3\S3Client,
Aws\Backup\BackupClient,
Aws\S3Control\S3ControlClient,
Aws\SageMaker\SageMakerClient,
Aws\SageMakerRuntime\SageMakerRuntimeClient,
Aws\SavingsPlans\SavingsPlansClient,
Aws\SecretsManager\SecretsManagerClient,
Aws\SecurityHub\SecurityHubClient,
Aws\ServerlessApplicationRepository\ServerlessApplicationRepositoryClient,
Aws\ServiceCatalog\ServiceCatalogClient,
Aws\ServiceDiscovery\ServiceDiscoveryClient,
Aws\ServiceQuotas\ServiceQuotasClient,
Aws\Batch\BatchClient,
Aws\Ses\SesClient,
Aws\SesV2\SesV2Client,
Aws\Sfn\SfnClient,
Aws\Shield\ShieldClient,
Aws\signer\signerClient,
Aws\Sms\SmsClient,
Aws\SnowBall\SnowBallClient,
Aws\Sns\SnsClient,
Aws\Sqs\SqsClient,
Aws\Ssm\SsmClient,
Aws\Budgets\BudgetsClient,
Aws\SSO\SSOClient,
Aws\SSOOIDC\SSOOIDCClient,
Aws\StorageGateway\StorageGatewayClient,
Aws\Sts\StsClient,
Aws\Support\SupportClient,
Aws\Swf\SwfClient,
Aws\Textract\TextractClient,
Aws\TranscribeService\TranscribeServiceClient,
Aws\Transfer\TransferClient,
Aws\Translate\TranslateClient,
Aws\Chime\ChimeClient,
Aws\Waf\WafClient,
Aws\WafRegional\WafRegionalClient,
Aws\WorkDocs\WorkDocsClient,
Aws\WorkLink\WorkLinkClient,
Aws\WorkMail\WorkMailClient,
Aws\WorkMailMessageFlow\WorkMailMessageFlowClient,
Aws\WorkSpaces\WorkSpacesClient,
Aws\XRay\XRayClient,
Aws\AlexaForBusiness\AlexaForBusinessClient,
Aws\Cloud9\Cloud9Client,
Aws\CloudDirectory\CloudDirectoryClient,
Aws\CloudFormation\CloudFormationClient,
Aws\CloudFront\CloudFrontClient,
Aws\CloudHsm\CloudHsmClient,
Aws\CloudHSMV2\CloudHSMV2Client,
Aws\CloudSearch\CloudSearchClient,
Aws\CloudSearchDomain\CloudSearchDomainClient,
Aws\CloudTrail\CloudTrailClient,
Aws\CloudWatch\CloudWatchClient,
Aws\Amplify\AmplifyClient,
Aws\CloudWatchEvents\CloudWatchEventsClient,
Aws\CloudWatchLogs\CloudWatchLogsClient,
Aws\CodeBuild\CodeBuildClient,
Aws\CodeCommit\CodeCommitClient,
Aws\CodeDeploy\CodeDeployClient,
Aws\CodePipeline\CodePipelineClient,
Aws\CodeStar\CodeStarClient,
Aws\CodeStarNotifications\CodeStarNotificationsClient,
Aws\CognitoIdentity\CognitoIdentityClient,
Aws\CognitoIdentityProvider\CognitoIdentityProviderClient,
Aws\ApiGateway\ApiGatewayClient,
Aws\CognitoSync\CognitoSyncClient,
Aws\Comprehend\ComprehendClient,
Aws\ComprehendMedical\ComprehendMedicalClient,
Aws\ConfigService\ConfigServiceClient,
Aws\Connect\ConnectClient,
Aws\CostandUsageReportService\CostandUsageReportServiceClient,
Aws\CostExplorer\CostExplorerClient,
Aws\DatabaseMigrationService\DatabaseMigrationServiceClient,
Aws\DataExchange\DataExchangeClient,
Aws\DataPipeline\DataPipelineClient,
Aws\ApiGatewayManagementApi\ApiGatewayManagementApiClient,
Aws\DataSync\DataSyncClient,
Aws\DAX\DAXClient,
Aws\DeviceFarm\DeviceFarmClient,
Aws\DirectConnect\DirectConnectClient,
Aws\DirectoryService\DirectoryServiceClient,
Aws\DLM\DLMClient,
Aws\DocDB\DocDBClient,
Aws\DynamoDb\DynamoDbClient,
Aws\DynamoDbStreams\DynamoDbStreamsClient,
Aws\Ec2\Ec2Client,
Aws\ApiGatewayV2\ApiGatewayV2Client,
Aws\EC2InstanceConnect\EC2InstanceConnectClient,
Aws\Ecr\EcrClient,
Aws\Ecs\EcsClient,
Aws\Efs\EfsClient,
Aws\EKS\EKSClient,
Aws\ElastiCache\ElastiCacheClient,
Aws\ElasticBeanstalk\ElasticBeanstalkClient,
Aws\ElasticLoadBalancing\ElasticLoadBalancingClient,
Aws\ElasticLoadBalancingV2\ElasticLoadBalancingV2Client,
Aws\ElasticsearchService\ElasticsearchServiceClient,
Aws\ApplicationAutoScaling\ApplicationAutoScalingClient,
Aws\ElasticTranscoder\ElasticTranscoderClient,
Aws\Emr\EmrClient,
Aws\EventBridge\EventBridgeClient,
Aws\Firehose\FirehoseClient,
Aws\FMS\FMSClient,
Aws\ForecastQueryService\ForecastQueryServiceClient,
Aws\ForecastService\ForecastServiceClient,
Aws\FSx\FSxClient,
Aws\GameLift\GameLiftClient,
Aws\Glacier\GlacierClient,
Aws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient,
Aws\GlobalAccelerator\GlobalAcceleratorClient,
Aws\Glue\GlueClient,
Aws\Greengrass\GreengrassClient,
Aws\GroundStation\GroundStationClient,
Aws\GuardDuty\GuardDutyClient,
Aws\Health\HealthClient,
Aws\Iam\IamClient,
Aws\ImportExport\ImportExportClient,
Aws\Inspector\InspectorClient,
Aws\IoT1ClickDevicesService\IoT1ClickDevicesServiceClient,
Aws\ApplicationInsights\ApplicationInsightsClient,
Aws\IoT1ClickProjects\IoT1ClickProjectsClient,
Aws\Iot\IotClient,
Aws\IoTAnalytics\IoTAnalyticsClient,
Aws\IotDataPlane\IotDataPlaneClient,
Aws\IoTEvents\IoTEventsClient,
Aws\IoTEventsData\IoTEventsDataClient,
Aws\IoTJobsDataPlane\IoTJobsDataPlaneClient,
Aws\IoTThingsGraph\IoTThingsGraphClient,
Aws\Kafka\KafkaClient,
Aws\Kinesis\KinesisClient
Methods Summary
-
static
getArguments ( )
Get an array of client constructor arguments used by the client.
-
__construct ( array $args )
The client constructor accepts the following options:
-
getHandlerList ( )
Get the handler list used to transfer commands.
-
getConfig ( string|null $option = null )
Get a client configuration value.
-
getCredentials ( )
Returns a promise that is fulfilled with an
Aws\Credentials\CredentialsInterfaceobject. -
getEndpoint ( )
Gets the default endpoint, or base URL, used by the client.
-
getRegion ( )
Get the region to which the client is configured to send requests.
-
getApi ( )
Get the service description associated with the client.
-
getCommand ( string $name, array $args = [] )
Create a command for an operation name.
- __sleep ( )
-
static
applyDocFilters ( array $api, array $docs )
Returns a service model and doc model with any necessary changes applied.
- static factory ( array $config = [] )
Methods inherited from Aws\AwsClientInterface
Methods used from Aws\AwsClientTrait
Methods Details
static array getArguments ( )
Get an array of client constructor arguments used by the client.
Returns
| array |
__construct ( array $args )
The client constructor accepts the following options:
- api_provider: (callable) An optional PHP callable that accepts a type, service, and version argument, and returns an array of corresponding configuration data. The type value can be one of api, waiter, or paginator.
- credentials: (Aws\Credentials\CredentialsInterface|array|bool|callable) Specifies the credentials used to sign requests. Provide an Aws\Credentials\CredentialsInterface object, an associative array of "key", "secret", and an optional "token" key,
falseto use null credentials, or a callable credentials provider used to create credentials or return null. See Aws\Credentials\CredentialProvider for a list of built-in credentials providers. If no credentials are provided, the SDK will attempt to load them from the environment. - csm: (Aws\ClientSideMonitoring\ConfigurationInterface|array|callable) Specifies the credentials used to sign requests. Provide an Aws\ClientSideMonitoring\ConfigurationInterface object, a callable configuration provider used to create client-side monitoring configuration,
falseto disable csm, or an associative array with the following keys: enabled: (bool) Set to true to enable client-side monitoring, defaults to false; host: (string) the host location to send monitoring events to, defaults to 127.0.0.1; port: (int) The port used for the host connection, defaults to 31000; client_id: (string) An identifier for this project - debug: (bool|array) Set to true to display debug information when sending requests. Alternatively, you can provide an associative array with the following keys: logfn: (callable) Function that is invoked with log messages; stream_size: (int) When the size of a stream is greater than this number, the stream data will not be logged (set to "0" to not log any stream data); scrub_auth: (bool) Set to false to disable the scrubbing of auth data from the logged messages; http: (bool) Set to false to disable the "debug" feature of lower level HTTP adapters (e.g., verbose curl output).
- stats: (bool|array) Set to true to gather transfer statistics on requests sent. Alternatively, you can provide an associative array with the following keys: retries: (bool) Set to false to disable reporting on retries attempted; http: (bool) Set to true to enable collecting statistics from lower level HTTP adapters (e.g., values returned in GuzzleHttp\TransferStats). HTTP handlers must support an
http_stats_receiveroption for this to have an effect; timer: (bool) Set to true to enable a command timer that reports the total wall clock time spent on an operation in seconds. - disable_host_prefix_injection: (bool) Set to true to disable host prefix injection logic for services that use it. This disables the entire prefix injection, including the portions supplied by user-defined parameters. Setting this flag will have no effect on services that do not use host prefix injection.
- endpoint: (string) The full URI of the webservice. This is only required when connecting to a custom endpoint (e.g., a local version of S3).
- endpoint_discovery: (Aws\EndpointDiscovery\ConfigurationInterface, Aws\CacheInterface, array, callable) Settings for endpoint discovery. Provide an instance of Aws\EndpointDiscovery\ConfigurationInterface, an instance Aws\CacheInterface, a callable that provides a promise for a Configuration object, or an associative array with the following keys: enabled: (bool) Set to true to enable endpoint discovery, defaults to false; cache_limit: (int) The maximum number of keys in the endpoints cache, defaults to 1000.
- endpoint_provider: (callable) An optional PHP callable that accepts a hash of options including a "service" and "region" key and returns NULL or a hash of endpoint data, of which the "endpoint" key is required. See Aws\Endpoint\EndpointProvider for a list of built-in providers.
- handler: (callable) A handler that accepts a command object, request object and returns a promise that is fulfilled with an Aws\ResultInterface object or rejected with an Aws\Exception\AwsException. A handler does not accept a next handler as it is terminal and expected to fulfill a command. If no handler is provided, a default Guzzle handler will be utilized.
- http: (array, default=array(0)) Set to an array of SDK request options to apply to each request (e.g., proxy, verify, etc.).
- http_handler: (callable) An HTTP handler is a function that accepts a PSR-7 request object and returns a promise that is fulfilled with a PSR-7 response object or rejected with an array of exception data. NOTE: This option supersedes any provided "handler" option.
- idempotency_auto_fill: (bool|callable) Set to false to disable SDK to populate parameters that enabled 'idempotencyToken' trait with a random UUID v4 value on your behalf. Using default value 'true' still allows parameter value to be overwritten when provided. Note: auto-fill only works when cryptographically secure random bytes generator functions (random_bytes, openssl_random_pseudo_bytes or mcrypt_create_iv) can be found. You may also provide a callable source of random bytes.
- profile: (string) Allows you to specify which profile to use when credentials are created from the AWS credentials file in your HOME directory. This setting overrides the AWS_PROFILE environment variable. Note: Specifying "profile" will cause the "credentials" key to be ignored.
- region: (string, required) Region to connect to. See http://docs.aws.amazon.com/general/latest/gr/rande.html for a list of available regions.
- retries: (int, default=int(3)) Configures the maximum number of allowed retries for a client (pass 0 to disable retries).
- scheme: (string, default=string(5) "https") URI scheme to use when connecting connect. The SDK will utilize "https" endpoints (i.e., utilize SSL/TLS connections) by default. You can attempt to connect to a service over an unencrypted "http" endpoint by setting
schemeto "http". - signature_provider: (callable) A callable that accepts a signature version name (e.g., "v4"), a service name, and region, and returns a SignatureInterface object or null. This provider is used to create signers utilized by the client. See Aws\Signature\SignatureProvider for a list of built-in providers
- signature_version: (string) A string representing a custom signature version to use with a service (e.g., v4). Note that per/operation signature version MAY override this requested signature version.
- validate: (bool, default=bool(true)) Set to false to disable client-side parameter validation.
- version: (string, required) The version of the webservice to utilize (e.g., 2006-03-01).
Parameters
| array | $args | Client configuration arguments. |
Exceptions
| InvalidArgumentException if any required options are missing or the service is not supported. |
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 |
Implementation of
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 |
Implementation of
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
| PromiseInterface |
Implementation of
UriInterface getEndpoint ( )
Gets the default endpoint, or base URL, used by the client.
Returns
| UriInterface |
Implementation of
string getRegion ( )
Get the region to which the client is configured to send requests.
Returns
| string |
Implementation of
Aws\Api\Service
getApi (
)
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 |
Implementation of
__sleep ( )
static array applyDocFilters ( array $api, array $docs )
Returns a service model and doc model with any necessary changes applied.
Parameters
| array | $api | Array of service data being documented. |
| array | $docs | Array of doc model data. |
Returns
| array Tuple containing a [Service, DocModel] |
Codecoverageignore
static static factory ( array $config = [] )
Deprecated
Returns
| static |
