/libraries/fabrik/vendor/aws/aws-sdk-php/src/S3Control/S3ControlClient.php
https://github.com/trob/fabrik · PHP · 206 lines · 85 code · 4 blank · 117 comment · 5 complexity · 4e28711821ffc7bb9258052e3d0b80f5 MD5 · raw file
- <?php
- namespace Aws\S3Control;
- use Aws\AwsClient;
- use Aws\CacheInterface;
- use Aws\HandlerList;
- use Aws\S3\UseArnRegion\Configuration;
- use Aws\S3\UseArnRegion\ConfigurationInterface;
- use Aws\S3\UseArnRegion\ConfigurationProvider as UseArnRegionConfigurationProvider;
- use GuzzleHttp\Promise\PromiseInterface;
- /**
- * This client is used to interact with the **AWS S3 Control** service.
- * @method \Aws\Result createAccessPoint(array $args = [])
- * @method \GuzzleHttp\Promise\Promise createAccessPointAsync(array $args = [])
- * @method \Aws\Result createAccessPointForObjectLambda(array $args = [])
- * @method \GuzzleHttp\Promise\Promise createAccessPointForObjectLambdaAsync(array $args = [])
- * @method \Aws\Result createBucket(array $args = [])
- * @method \GuzzleHttp\Promise\Promise createBucketAsync(array $args = [])
- * @method \Aws\Result createJob(array $args = [])
- * @method \GuzzleHttp\Promise\Promise createJobAsync(array $args = [])
- * @method \Aws\Result deleteAccessPoint(array $args = [])
- * @method \GuzzleHttp\Promise\Promise deleteAccessPointAsync(array $args = [])
- * @method \Aws\Result deleteAccessPointForObjectLambda(array $args = [])
- * @method \GuzzleHttp\Promise\Promise deleteAccessPointForObjectLambdaAsync(array $args = [])
- * @method \Aws\Result deleteAccessPointPolicy(array $args = [])
- * @method \GuzzleHttp\Promise\Promise deleteAccessPointPolicyAsync(array $args = [])
- * @method \Aws\Result deleteAccessPointPolicyForObjectLambda(array $args = [])
- * @method \GuzzleHttp\Promise\Promise deleteAccessPointPolicyForObjectLambdaAsync(array $args = [])
- * @method \Aws\Result deleteBucket(array $args = [])
- * @method \GuzzleHttp\Promise\Promise deleteBucketAsync(array $args = [])
- * @method \Aws\Result deleteBucketLifecycleConfiguration(array $args = [])
- * @method \GuzzleHttp\Promise\Promise deleteBucketLifecycleConfigurationAsync(array $args = [])
- * @method \Aws\Result deleteBucketPolicy(array $args = [])
- * @method \GuzzleHttp\Promise\Promise deleteBucketPolicyAsync(array $args = [])
- * @method \Aws\Result deleteBucketTagging(array $args = [])
- * @method \GuzzleHttp\Promise\Promise deleteBucketTaggingAsync(array $args = [])
- * @method \Aws\Result deleteJobTagging(array $args = [])
- * @method \GuzzleHttp\Promise\Promise deleteJobTaggingAsync(array $args = [])
- * @method \Aws\Result deletePublicAccessBlock(array $args = [])
- * @method \GuzzleHttp\Promise\Promise deletePublicAccessBlockAsync(array $args = [])
- * @method \Aws\Result deleteStorageLensConfiguration(array $args = [])
- * @method \GuzzleHttp\Promise\Promise deleteStorageLensConfigurationAsync(array $args = [])
- * @method \Aws\Result deleteStorageLensConfigurationTagging(array $args = [])
- * @method \GuzzleHttp\Promise\Promise deleteStorageLensConfigurationTaggingAsync(array $args = [])
- * @method \Aws\Result describeJob(array $args = [])
- * @method \GuzzleHttp\Promise\Promise describeJobAsync(array $args = [])
- * @method \Aws\Result getAccessPoint(array $args = [])
- * @method \GuzzleHttp\Promise\Promise getAccessPointAsync(array $args = [])
- * @method \Aws\Result getAccessPointConfigurationForObjectLambda(array $args = [])
- * @method \GuzzleHttp\Promise\Promise getAccessPointConfigurationForObjectLambdaAsync(array $args = [])
- * @method \Aws\Result getAccessPointForObjectLambda(array $args = [])
- * @method \GuzzleHttp\Promise\Promise getAccessPointForObjectLambdaAsync(array $args = [])
- * @method \Aws\Result getAccessPointPolicy(array $args = [])
- * @method \GuzzleHttp\Promise\Promise getAccessPointPolicyAsync(array $args = [])
- * @method \Aws\Result getAccessPointPolicyForObjectLambda(array $args = [])
- * @method \GuzzleHttp\Promise\Promise getAccessPointPolicyForObjectLambdaAsync(array $args = [])
- * @method \Aws\Result getAccessPointPolicyStatus(array $args = [])
- * @method \GuzzleHttp\Promise\Promise getAccessPointPolicyStatusAsync(array $args = [])
- * @method \Aws\Result getAccessPointPolicyStatusForObjectLambda(array $args = [])
- * @method \GuzzleHttp\Promise\Promise getAccessPointPolicyStatusForObjectLambdaAsync(array $args = [])
- * @method \Aws\Result getBucket(array $args = [])
- * @method \GuzzleHttp\Promise\Promise getBucketAsync(array $args = [])
- * @method \Aws\Result getBucketLifecycleConfiguration(array $args = [])
- * @method \GuzzleHttp\Promise\Promise getBucketLifecycleConfigurationAsync(array $args = [])
- * @method \Aws\Result getBucketPolicy(array $args = [])
- * @method \GuzzleHttp\Promise\Promise getBucketPolicyAsync(array $args = [])
- * @method \Aws\Result getBucketTagging(array $args = [])
- * @method \GuzzleHttp\Promise\Promise getBucketTaggingAsync(array $args = [])
- * @method \Aws\Result getJobTagging(array $args = [])
- * @method \GuzzleHttp\Promise\Promise getJobTaggingAsync(array $args = [])
- * @method \Aws\Result getPublicAccessBlock(array $args = [])
- * @method \GuzzleHttp\Promise\Promise getPublicAccessBlockAsync(array $args = [])
- * @method \Aws\Result getStorageLensConfiguration(array $args = [])
- * @method \GuzzleHttp\Promise\Promise getStorageLensConfigurationAsync(array $args = [])
- * @method \Aws\Result getStorageLensConfigurationTagging(array $args = [])
- * @method \GuzzleHttp\Promise\Promise getStorageLensConfigurationTaggingAsync(array $args = [])
- * @method \Aws\Result listAccessPoints(array $args = [])
- * @method \GuzzleHttp\Promise\Promise listAccessPointsAsync(array $args = [])
- * @method \Aws\Result listAccessPointsForObjectLambda(array $args = [])
- * @method \GuzzleHttp\Promise\Promise listAccessPointsForObjectLambdaAsync(array $args = [])
- * @method \Aws\Result listJobs(array $args = [])
- * @method \GuzzleHttp\Promise\Promise listJobsAsync(array $args = [])
- * @method \Aws\Result listRegionalBuckets(array $args = [])
- * @method \GuzzleHttp\Promise\Promise listRegionalBucketsAsync(array $args = [])
- * @method \Aws\Result listStorageLensConfigurations(array $args = [])
- * @method \GuzzleHttp\Promise\Promise listStorageLensConfigurationsAsync(array $args = [])
- * @method \Aws\Result putAccessPointConfigurationForObjectLambda(array $args = [])
- * @method \GuzzleHttp\Promise\Promise putAccessPointConfigurationForObjectLambdaAsync(array $args = [])
- * @method \Aws\Result putAccessPointPolicy(array $args = [])
- * @method \GuzzleHttp\Promise\Promise putAccessPointPolicyAsync(array $args = [])
- * @method \Aws\Result putAccessPointPolicyForObjectLambda(array $args = [])
- * @method \GuzzleHttp\Promise\Promise putAccessPointPolicyForObjectLambdaAsync(array $args = [])
- * @method \Aws\Result putBucketLifecycleConfiguration(array $args = [])
- * @method \GuzzleHttp\Promise\Promise putBucketLifecycleConfigurationAsync(array $args = [])
- * @method \Aws\Result putBucketPolicy(array $args = [])
- * @method \GuzzleHttp\Promise\Promise putBucketPolicyAsync(array $args = [])
- * @method \Aws\Result putBucketTagging(array $args = [])
- * @method \GuzzleHttp\Promise\Promise putBucketTaggingAsync(array $args = [])
- * @method \Aws\Result putJobTagging(array $args = [])
- * @method \GuzzleHttp\Promise\Promise putJobTaggingAsync(array $args = [])
- * @method \Aws\Result putPublicAccessBlock(array $args = [])
- * @method \GuzzleHttp\Promise\Promise putPublicAccessBlockAsync(array $args = [])
- * @method \Aws\Result putStorageLensConfiguration(array $args = [])
- * @method \GuzzleHttp\Promise\Promise putStorageLensConfigurationAsync(array $args = [])
- * @method \Aws\Result putStorageLensConfigurationTagging(array $args = [])
- * @method \GuzzleHttp\Promise\Promise putStorageLensConfigurationTaggingAsync(array $args = [])
- * @method \Aws\Result updateJobPriority(array $args = [])
- * @method \GuzzleHttp\Promise\Promise updateJobPriorityAsync(array $args = [])
- * @method \Aws\Result updateJobStatus(array $args = [])
- * @method \GuzzleHttp\Promise\Promise updateJobStatusAsync(array $args = [])
- */
- class S3ControlClient extends AwsClient
- {
- public static function getArguments()
- {
- $args = parent::getArguments();
- return $args + [
- 'use_dual_stack_endpoint' => [
- 'type' => 'config',
- 'valid' => ['bool'],
- 'doc' => 'Set to true to send requests to an S3 Control Dual Stack'
- . ' endpoint by default, which enables IPv6 Protocol.'
- . ' Can be enabled or disabled on individual operations by setting'
- . ' \'@use_dual_stack_endpoint\' to true or false.',
- 'default' => false,
- ],
- 'use_arn_region' => [
- 'type' => 'config',
- 'valid' => [
- 'bool',
- Configuration::class,
- CacheInterface::class,
- 'callable'
- ],
- 'doc' => 'Set to true to allow passed in ARNs to override'
- . ' client region. Accepts...',
- 'fn' => [__CLASS__, '_apply_use_arn_region'],
- 'default' => [UseArnRegionConfigurationProvider::class, 'defaultProvider'],
- ],
- ];
- }
- public static function _apply_use_arn_region($value, array &$args, HandlerList $list)
- {
- if ($value instanceof CacheInterface) {
- $value = UseArnRegionConfigurationProvider::defaultProvider($args);
- }
- if (is_callable($value)) {
- $value = $value();
- }
- if ($value instanceof PromiseInterface) {
- $value = $value->wait();
- }
- if ($value instanceof ConfigurationInterface) {
- $args['use_arn_region'] = $value;
- } else {
- // The Configuration class itself will validate other inputs
- $args['use_arn_region'] = new Configuration($value);
- }
- }
- /**
- * {@inheritdoc}
- *
- * In addition to the options available to
- * {@see Aws\AwsClient::__construct}, S3ControlClient accepts the following
- * option:
- *
- * - use_dual_stack_endpoint: (bool) Set to true to send requests to an S3
- * Control Dual Stack endpoint by default, which enables IPv6 Protocol.
- * Can be enabled or disabled on individual operations by setting
- * '@use_dual_stack_endpoint\' to true or false. Note:
- * you cannot use it together with an accelerate endpoint.
- *
- * @param array $args
- */
- public function __construct(array $args)
- {
- parent::__construct($args);
- $stack = $this->getHandlerList();
- $stack->appendBuild(
- S3ControlEndpointMiddleware::wrap(
- $this->getRegion(),
- [
- 'dual_stack' => $this->getConfig('use_dual_stack_endpoint'),
- ]
- ),
- 's3control.endpoint_middleware'
- );
- $stack->appendBuild(
- EndpointArnMiddleware::wrap(
- $this->getApi(),
- $this->getRegion(),
- [
- 'use_arn_region' => $this->getConfig('use_arn_region'),
- 'dual_stack' => $this->getConfig('use_dual_stack_endpoint'),
- 'endpoint' => isset($args['endpoint'])
- ? $args['endpoint']
- : null
- ]
- ),
- 's3control.endpoint_arn_middleware'
- );
- }
- }