Class AwsClient
- Aws\AwsClient implements Aws\AwsClientInterface uses Aws\AwsClientTrait
- Namespace: Aws
- Located at AwsClient.php
Default AWS client implementation
Direct known subclasses
Aws\AccessAnalyzer\AccessAnalyzerClient
,
Aws\Account\AccountClient
,
Aws\ApiGatewayV2\ApiGatewayV2Client
,
Aws\CostExplorer\CostExplorerClient
,
Aws\CostOptimizationHub\CostOptimizationHubClient
,
Aws\CustomerProfiles\CustomerProfilesClient
,
Aws\DatabaseMigrationService\DatabaseMigrationServiceClient
,
Aws\DataExchange\DataExchangeClient
,
Aws\DataPipeline\DataPipelineClient
,
Aws\DataSync\DataSyncClient
,
Aws\DataZone\DataZoneClient
,
Aws\DAX\DAXClient
,
Aws\Deadline\DeadlineClient
,
Aws\AppConfig\AppConfigClient
,
Aws\Detective\DetectiveClient
,
Aws\DeviceFarm\DeviceFarmClient
,
Aws\DevOpsGuru\DevOpsGuruClient
,
Aws\DirectConnect\DirectConnectClient
,
Aws\DirectoryService\DirectoryServiceClient
,
Aws\DLM\DLMClient
,
Aws\DocDB\DocDBClient
,
Aws\DocDBElastic\DocDBElasticClient
,
Aws\drs\drsClient
,
Aws\DynamoDb\DynamoDbClient
,
Aws\AppConfigData\AppConfigDataClient
,
Aws\DynamoDbStreams\DynamoDbStreamsClient
,
Aws\EBS\EBSClient
,
Aws\Ec2\Ec2Client
,
Aws\EC2InstanceConnect\EC2InstanceConnectClient
,
Aws\Ecr\EcrClient
,
Aws\ECRPublic\ECRPublicClient
,
Aws\Ecs\EcsClient
,
Aws\Efs\EfsClient
,
Aws\EKS\EKSClient
,
Aws\EKSAuth\EKSAuthClient
,
Aws\AppFabric\AppFabricClient
,
Aws\ElastiCache\ElastiCacheClient
,
Aws\ElasticBeanstalk\ElasticBeanstalkClient
,
Aws\ElasticInference\ElasticInferenceClient
,
Aws\ElasticLoadBalancing\ElasticLoadBalancingClient
,
Aws\ElasticLoadBalancingV2\ElasticLoadBalancingV2Client
,
Aws\ElasticsearchService\ElasticsearchServiceClient
,
Aws\ElasticTranscoder\ElasticTranscoderClient
,
Aws\Emr\EmrClient
,
Aws\EMRContainers\EMRContainersClient
,
Aws\EMRServerless\EMRServerlessClient
,
Aws\Appflow\AppflowClient
,
Aws\EntityResolution\EntityResolutionClient
,
Aws\EventBridge\EventBridgeClient
,
Aws\finspace\finspaceClient
,
Aws\FinSpaceData\FinSpaceDataClient
,
Aws\Firehose\FirehoseClient
,
Aws\FIS\FISClient
,
Aws\FMS\FMSClient
,
Aws\ForecastQueryService\ForecastQueryServiceClient
,
Aws\ForecastService\ForecastServiceClient
,
Aws\FraudDetector\FraudDetectorClient
,
Aws\AppIntegrationsService\AppIntegrationsServiceClient
,
Aws\FreeTier\FreeTierClient
,
Aws\FSx\FSxClient
,
Aws\GameLift\GameLiftClient
,
Aws\Glacier\GlacierClient
,
Aws\GlobalAccelerator\GlobalAcceleratorClient
,
Aws\Glue\GlueClient
,
Aws\GlueDataBrew\GlueDataBrewClient
,
Aws\Greengrass\GreengrassClient
,
Aws\GreengrassV2\GreengrassV2Client
,
Aws\GroundStation\GroundStationClient
,
Aws\ApplicationAutoScaling\ApplicationAutoScalingClient
,
Aws\GuardDuty\GuardDutyClient
,
Aws\Health\HealthClient
,
Aws\HealthLake\HealthLakeClient
,
Aws\Honeycode\HoneycodeClient
,
Aws\Iam\IamClient
,
Aws\IdentityStore\IdentityStoreClient
,
Aws\imagebuilder\imagebuilderClient
,
Aws\ImportExport\ImportExportClient
,
Aws\Inspector2\Inspector2Client
,
Aws\Inspector\InspectorClient
,
Aws\ApplicationCostProfiler\ApplicationCostProfilerClient
,
Aws\InspectorScan\InspectorScanClient
,
Aws\InternetMonitor\InternetMonitorClient
,
Aws\IoT1ClickDevicesService\IoT1ClickDevicesServiceClient
,
Aws\IoT1ClickProjects\IoT1ClickProjectsClient
,
Aws\Iot\IotClient
,
Aws\IoTAnalytics\IoTAnalyticsClient
,
Aws\IotDataPlane\IotDataPlaneClient
,
Aws\IoTDeviceAdvisor\IoTDeviceAdvisorClient
,
Aws\IoTEvents\IoTEventsClient
,
Aws\IoTEventsData\IoTEventsDataClient
,
Aws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient
,
Aws\IoTFleetHub\IoTFleetHubClient
,
Aws\IoTFleetWise\IoTFleetWiseClient
,
Aws\IoTJobsDataPlane\IoTJobsDataPlaneClient
,
Aws\IoTSecureTunneling\IoTSecureTunnelingClient
,
Aws\IoTSiteWise\IoTSiteWiseClient
,
Aws\IoTThingsGraph\IoTThingsGraphClient
,
Aws\IoTTwinMaker\IoTTwinMakerClient
,
Aws\IoTWireless\IoTWirelessClient
,
Aws\IVS\IVSClient
,
Aws\ivschat\ivschatClient
,
Aws\ApplicationInsights\ApplicationInsightsClient
,
Aws\IVSRealTime\IVSRealTimeClient
,
Aws\Kafka\KafkaClient
,
Aws\KafkaConnect\KafkaConnectClient
,
Aws\kendra\kendraClient
,
Aws\KendraRanking\KendraRankingClient
,
Aws\Keyspaces\KeyspacesClient
,
Aws\Kinesis\KinesisClient
,
Aws\KinesisAnalytics\KinesisAnalyticsClient
,
Aws\KinesisAnalyticsV2\KinesisAnalyticsV2Client
,
Aws\KinesisVideo\KinesisVideoClient
,
Aws\Acm\AcmClient
,
Aws\AppMesh\AppMeshClient
,
Aws\KinesisVideoArchivedMedia\KinesisVideoArchivedMediaClient
,
Aws\KinesisVideoMedia\KinesisVideoMediaClient
,
Aws\KinesisVideoSignalingChannels\KinesisVideoSignalingChannelsClient
,
Aws\KinesisVideoWebRTCStorage\KinesisVideoWebRTCStorageClient
,
Aws\Kms\KmsClient
,
Aws\LakeFormation\LakeFormationClient
,
Aws\Lambda\LambdaClient
,
Aws\LaunchWizard\LaunchWizardClient
,
Aws\LexModelBuildingService\LexModelBuildingServiceClient
,
Aws\LexModelsV2\LexModelsV2Client
,
Aws\AppRegistry\AppRegistryClient
,
Aws\LexRuntimeService\LexRuntimeServiceClient
,
Aws\LexRuntimeV2\LexRuntimeV2Client
,
Aws\LicenseManager\LicenseManagerClient
,
Aws\LicenseManagerLinuxSubscriptions\LicenseManagerLinuxSubscriptionsClient
,
Aws\LicenseManagerUserSubscriptions\LicenseManagerUserSubscriptionsClient
,
Aws\Lightsail\LightsailClient
,
Aws\LocationService\LocationServiceClient
,
Aws\LookoutEquipment\LookoutEquipmentClient
,
Aws\LookoutforVision\LookoutforVisionClient
,
Aws\LookoutMetrics\LookoutMetricsClient
,
Aws\AppRunner\AppRunnerClient
,
Aws\MachineLearning\MachineLearningClient
,
Aws\Macie2\Macie2Client
,
Aws\MainframeModernization\MainframeModernizationClient
,
Aws\ManagedBlockchain\ManagedBlockchainClient
,
Aws\ManagedBlockchainQuery\ManagedBlockchainQueryClient
,
Aws\ManagedGrafana\ManagedGrafanaClient
,
Aws\MarketplaceAgreement\MarketplaceAgreementClient
,
Aws\MarketplaceCatalog\MarketplaceCatalogClient
,
Aws\MarketplaceCommerceAnalytics\MarketplaceCommerceAnalyticsClient
,
Aws\MarketplaceDeployment\MarketplaceDeploymentClient
,
Aws\Appstream\AppstreamClient
,
Aws\MarketplaceEntitlementService\MarketplaceEntitlementServiceClient
,
Aws\MarketplaceMetering\MarketplaceMeteringClient
,
Aws\MediaConnect\MediaConnectClient
,
Aws\MediaConvert\MediaConvertClient
,
Aws\MediaLive\MediaLiveClient
,
Aws\MediaPackage\MediaPackageClient
,
Aws\MediaPackageV2\MediaPackageV2Client
,
Aws\MediaPackageVod\MediaPackageVodClient
,
Aws\MediaStore\MediaStoreClient
,
Aws\MediaStoreData\MediaStoreDataClient
,
Aws\AppSync\AppSyncClient
,
Aws\MediaTailor\MediaTailorClient
,
Aws\MedicalImaging\MedicalImagingClient
,
Aws\MemoryDB\MemoryDBClient
,
Aws\mgn\mgnClient
,
Aws\MigrationHub\MigrationHubClient
,
Aws\MigrationHubConfig\MigrationHubConfigClient
,
Aws\MigrationHubOrchestrator\MigrationHubOrchestratorClient
,
Aws\MigrationHubRefactorSpaces\MigrationHubRefactorSpacesClient
,
Aws\MigrationHubStrategyRecommendations\MigrationHubStrategyRecommendationsClient
,
Aws\Mobile\MobileClient
,
Aws\ARCZonalShift\ARCZonalShiftClient
,
Aws\MQ\MQClient
,
Aws\MTurk\MTurkClient
,
Aws\MWAA\MWAAClient
,
Aws\Neptune\NeptuneClient
,
Aws\Neptunedata\NeptunedataClient
,
Aws\NeptuneGraph\NeptuneGraphClient
,
Aws\NetworkFirewall\NetworkFirewallClient
,
Aws\NetworkManager\NetworkManagerClient
,
Aws\NetworkMonitor\NetworkMonitorClient
,
Aws\NimbleStudio\NimbleStudioClient
,
Aws\Artifact\ArtifactClient
,
Aws\OAM\OAMClient
,
Aws\Omics\OmicsClient
,
Aws\OpenSearchServerless\OpenSearchServerlessClient
,
Aws\OpenSearchService\OpenSearchServiceClient
,
Aws\OpsWorks\OpsWorksClient
,
Aws\OpsWorksCM\OpsWorksCMClient
,
Aws\Organizations\OrganizationsClient
,
Aws\OSIS\OSISClient
,
Aws\Outposts\OutpostsClient
,
Aws\Panorama\PanoramaClient
,
Aws\Athena\AthenaClient
,
Aws\PaymentCryptography\PaymentCryptographyClient
,
Aws\PaymentCryptographyData\PaymentCryptographyDataClient
,
Aws\PcaConnectorAd\PcaConnectorAdClient
,
Aws\Personalize\PersonalizeClient
,
Aws\PersonalizeEvents\PersonalizeEventsClient
,
Aws\PersonalizeRuntime\PersonalizeRuntimeClient
,
Aws\PI\PIClient
,
Aws\Pinpoint\PinpointClient
,
Aws\PinpointEmail\PinpointEmailClient
,
Aws\PinpointSMSVoice\PinpointSMSVoiceClient
,
Aws\AuditManager\AuditManagerClient
,
Aws\PinpointSMSVoiceV2\PinpointSMSVoiceV2Client
,
Aws\Pipes\PipesClient
,
Aws\Polly\PollyClient
,
Aws\Pricing\PricingClient
,
Aws\PrivateNetworks\PrivateNetworksClient
,
Aws\PrometheusService\PrometheusServiceClient
,
Aws\Proton\ProtonClient
,
Aws\QBusiness\QBusinessClient
,
Aws\QConnect\QConnectClient
,
Aws\QLDB\QLDBClient
,
Aws\AugmentedAIRuntime\AugmentedAIRuntimeClient
,
Aws\QLDBSession\QLDBSessionClient
,
Aws\QuickSight\QuickSightClient
,
Aws\RAM\RAMClient
,
Aws\Rds\RdsClient
,
Aws\RDSDataService\RDSDataServiceClient
,
Aws\RecycleBin\RecycleBinClient
,
Aws\Redshift\RedshiftClient
,
Aws\RedshiftDataAPIService\RedshiftDataAPIServiceClient
,
Aws\RedshiftServerless\RedshiftServerlessClient
,
Aws\Rekognition\RekognitionClient
,
Aws\ACMPCA\ACMPCAClient
,
Aws\AutoScaling\AutoScalingClient
,
Aws\Repostspace\RepostspaceClient
,
Aws\ResilienceHub\ResilienceHubClient
,
Aws\ResourceExplorer2\ResourceExplorer2Client
,
Aws\ResourceGroups\ResourceGroupsClient
,
Aws\ResourceGroupsTaggingAPI\ResourceGroupsTaggingAPIClient
,
Aws\RoboMaker\RoboMakerClient
,
Aws\RolesAnywhere\RolesAnywhereClient
,
Aws\Route53\Route53Client
,
Aws\Route53Domains\Route53DomainsClient
,
Aws\Route53Profiles\Route53ProfilesClient
,
Aws\AutoScalingPlans\AutoScalingPlansClient
,
Aws\Route53RecoveryCluster\Route53RecoveryClusterClient
,
Aws\Route53RecoveryControlConfig\Route53RecoveryControlConfigClient
,
Aws\Route53RecoveryReadiness\Route53RecoveryReadinessClient
,
Aws\Route53Resolver\Route53ResolverClient
,
Aws\S3\S3Client
,
Aws\S3Control\S3ControlClient
,
Aws\S3Outposts\S3OutpostsClient
,
Aws\SageMaker\SageMakerClient
,
Aws\SagemakerEdgeManager\SagemakerEdgeManagerClient
,
Aws\SageMakerFeatureStoreRuntime\SageMakerFeatureStoreRuntimeClient
,
Aws\B2bi\B2biClient
,
Aws\SageMakerGeospatial\SageMakerGeospatialClient
,
Aws\SageMakerMetrics\SageMakerMetricsClient
,
Aws\SageMakerRuntime\SageMakerRuntimeClient
,
Aws\SavingsPlans\SavingsPlansClient
,
Aws\Scheduler\SchedulerClient
,
Aws\Schemas\SchemasClient
,
Aws\SecretsManager\SecretsManagerClient
,
Aws\SecurityHub\SecurityHubClient
,
Aws\SecurityLake\SecurityLakeClient
,
Aws\ServerlessApplicationRepository\ServerlessApplicationRepositoryClient
,
Aws\Backup\BackupClient
,
Aws\ServiceCatalog\ServiceCatalogClient
,
Aws\ServiceDiscovery\ServiceDiscoveryClient
,
Aws\ServiceQuotas\ServiceQuotasClient
,
Aws\Ses\SesClient
,
Aws\SesV2\SesV2Client
,
Aws\Sfn\SfnClient
,
Aws\Shield\ShieldClient
,
Aws\signer\signerClient
,
Aws\SimSpaceWeaver\SimSpaceWeaverClient
,
Aws\Sms\SmsClient
,
Aws\BackupGateway\BackupGatewayClient
,
Aws\SnowBall\SnowBallClient
,
Aws\SnowDeviceManagement\SnowDeviceManagementClient
,
Aws\Sns\SnsClient
,
Aws\Sqs\SqsClient
,
Aws\Ssm\SsmClient
,
Aws\SSMContacts\SSMContactsClient
,
Aws\SSMIncidents\SSMIncidentsClient
,
Aws\SsmSap\SsmSapClient
,
Aws\SSO\SSOClient
,
Aws\SSOAdmin\SSOAdminClient
,
Aws\BackupStorage\BackupStorageClient
,
Aws\SSOOIDC\SSOOIDCClient
,
Aws\StorageGateway\StorageGatewayClient
,
Aws\Sts\StsClient
,
Aws\SupplyChain\SupplyChainClient
,
Aws\Support\SupportClient
,
Aws\SupportApp\SupportAppClient
,
Aws\Swf\SwfClient
,
Aws\Synthetics\SyntheticsClient
,
Aws\Textract\TextractClient
,
Aws\TimestreamInfluxDB\TimestreamInfluxDBClient
,
Aws\Batch\BatchClient
,
Aws\TimestreamQuery\TimestreamQueryClient
,
Aws\TimestreamWrite\TimestreamWriteClient
,
Aws\Tnb\TnbClient
,
Aws\TranscribeService\TranscribeServiceClient
,
Aws\Transfer\TransferClient
,
Aws\Translate\TranslateClient
,
Aws\TrustedAdvisor\TrustedAdvisorClient
,
Aws\VerifiedPermissions\VerifiedPermissionsClient
,
Aws\VoiceID\VoiceIDClient
,
Aws\VPCLattice\VPCLatticeClient
,
Aws\BCMDataExports\BCMDataExportsClient
,
Aws\Waf\WafClient
,
Aws\WafRegional\WafRegionalClient
,
Aws\WAFV2\WAFV2Client
,
Aws\WellArchitected\WellArchitectedClient
,
Aws\WorkDocs\WorkDocsClient
,
Aws\WorkLink\WorkLinkClient
,
Aws\WorkMail\WorkMailClient
,
Aws\WorkMailMessageFlow\WorkMailMessageFlowClient
,
Aws\WorkSpaces\WorkSpacesClient
,
Aws\WorkSpacesThinClient\WorkSpacesThinClientClient
,
Aws\Bedrock\BedrockClient
,
Aws\WorkSpacesWeb\WorkSpacesWebClient
,
Aws\XRay\XRayClient
,
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\CodeConnections\CodeConnectionsClient
,
Aws\CodeDeploy\CodeDeployClient
,
Aws\CodeGuruProfiler\CodeGuruProfilerClient
,
Aws\CodeGuruReviewer\CodeGuruReviewerClient
,
Aws\CodeGuruSecurity\CodeGuruSecurityClient
,
Aws\ApiGateway\ApiGatewayClient
,
Aws\CodePipeline\CodePipelineClient
,
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\ApiGatewayManagementApi\ApiGatewayManagementApiClient
,
Aws\ConfigService\ConfigServiceClient
,
Aws\Connect\ConnectClient
,
Aws\ConnectCampaignService\ConnectCampaignServiceClient
,
Aws\ConnectCases\ConnectCasesClient
,
Aws\ConnectContactLens\ConnectContactLensClient
,
Aws\ConnectParticipant\ConnectParticipantClient
,
Aws\ConnectWisdomService\ConnectWisdomServiceClient
,
Aws\ControlCatalog\ControlCatalogClient
,
Aws\ControlTower\ControlTowerClient
,
Aws\CostandUsageReportService\CostandUsageReportServiceClient
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\CredentialsInterface
object. -
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.
- getEndpointProvider ( )
-
getClientContextParams ( )
Provides the set of service context parameter key-value pairs used for endpoint resolution.
-
getClientBuiltIns ( )
Provides the set of built-in keys and values used for endpoint resolution
- __sleep ( )
-
final
getSignatureProvider ( )
Get the signature_provider function of the client.
-
getEndpointProviderArgs ( )
Retrieves arguments to be used in endpoint resolution.
- static emitDeprecationWarning ( )
-
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,
false
to 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. - token: (Aws\Token\TokenInterface|array|bool|callable) Specifies the token used to authorize requests. Provide an Aws\Token\TokenInterface object, an associative array of "token" and an optional "expires" key,
false
to use no token, or a callable token provider used to create a token or return null. See Aws\Token\TokenProvider for a list of built-in token providers. If no token is provided, the SDK will attempt to load one 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,
false
to 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_receiver
option 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, false to explicitly disable it, 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, Aws\Retry\ConfigurationInterface, Aws\CacheInterface, array, callable) Configures the retry mode and maximum number of allowed retries for a client (pass 0 to disable retries). Provide an integer for 'legacy' mode with the specified number of retries. Otherwise provide an instance of Aws\Retry\ConfigurationInterface, an instance of Aws\CacheInterface, a callable function, or an array with the following keys: mode: (string) Set to 'legacy', 'standard' (uses retry quota management), or 'adapative' (an experimental mode that adds client-side rate limiting to standard mode); max_attempts (int) The maximum number of attempts for a given request.
- 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
scheme
to "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.
- use_aws_shared_config_files: (bool, default=bool(true)) Set to false to disable checking for shared config file in '~/.aws/config' and '~/.aws/credentials'. This will override the AWS_CONFIG_FILE environment variable.
- 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
getEndpointProvider ( )
array getClientContextParams ( )
Provides the set of service context parameter key-value pairs used for endpoint resolution.
Returns
array |
array getClientBuiltIns ( )
Provides the set of built-in keys and values used for endpoint resolution
Returns
array |
__sleep ( )
callable getSignatureProvider ( )
Get the signature_provider function of the client.
Returns
callable |
array getEndpointProviderArgs ( )
Retrieves arguments to be used in endpoint resolution.
Returns
array |
static emitDeprecationWarning ( )
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 |