vendor/aws/aws-sdk-php/src/S3/S3Client.php line 383

Open in your IDE?
  1. <?php
  2. namespace Aws\S3;
  4. use Aws\Api\ApiProvider;
  5. use Aws\Api\DocModel;
  6. use Aws\Api\Service;
  7. use Aws\AwsClient;
  8. use Aws\CacheInterface;
  9. use Aws\ClientResolver;
  10. use Aws\Command;
  11. use Aws\CommandInterface;
  12. use Aws\Configuration\ConfigurationResolver;
  13. use Aws\Exception\AwsException;
  14. use Aws\HandlerList;
  15. use Aws\Identity\S3\S3ExpressIdentityProvider;
  16. use Aws\InputValidationMiddleware;
  17. use Aws\Middleware;
  18. use Aws\ResultInterface;
  19. use Aws\Retry\QuotaManager;
  20. use Aws\RetryMiddleware;
  21. use Aws\RetryMiddlewareV2;
  22. use Aws\S3\Parser\GetBucketLocationResultMutator;
  23. use Aws\S3\Parser\S3Parser;
  24. use Aws\S3\Parser\ValidateResponseChecksumResultMutator;
  25. use Aws\S3\RegionalEndpoint\ConfigurationProvider;
  26. use Aws\S3\UseArnRegion\Configuration;
  27. use Aws\S3\UseArnRegion\ConfigurationInterface;
  28. use Aws\S3\UseArnRegion\ConfigurationProvider as UseArnRegionConfigurationProvider;
  29. use GuzzleHttp\Exception\RequestException;
  30. use GuzzleHttp\Promise\PromiseInterface;
  31. use Psr\Http\Message\RequestInterface;
  33. /**
  34.  * Client used to interact with **Amazon Simple Storage Service (Amazon S3)**.
  35.  *
  36.  * @method \Aws\Result abortMultipartUpload(array $args = [])
  37.  * @method \GuzzleHttp\Promise\Promise abortMultipartUploadAsync(array $args = [])
  38.  * @method \Aws\Result completeMultipartUpload(array $args = [])
  39.  * @method \GuzzleHttp\Promise\Promise completeMultipartUploadAsync(array $args = [])
  40.  * @method \Aws\Result copyObject(array $args = [])
  41.  * @method \GuzzleHttp\Promise\Promise copyObjectAsync(array $args = [])
  42.  * @method \Aws\Result createBucket(array $args = [])
  43.  * @method \GuzzleHttp\Promise\Promise createBucketAsync(array $args = [])
  44.  * @method \Aws\Result createBucketMetadataTableConfiguration(array $args = [])
  45.  * @method \GuzzleHttp\Promise\Promise createBucketMetadataTableConfigurationAsync(array $args = [])
  46.  * @method \Aws\Result createMultipartUpload(array $args = [])
  47.  * @method \GuzzleHttp\Promise\Promise createMultipartUploadAsync(array $args = [])
  48.  * @method \Aws\Result createSession(array $args = [])
  49.  * @method \GuzzleHttp\Promise\Promise createSessionAsync(array $args = [])
  50.  * @method \Aws\Result deleteBucket(array $args = [])
  51.  * @method \GuzzleHttp\Promise\Promise deleteBucketAsync(array $args = [])
  52.  * @method \Aws\Result deleteBucketAnalyticsConfiguration(array $args = [])
  53.  * @method \GuzzleHttp\Promise\Promise deleteBucketAnalyticsConfigurationAsync(array $args = [])
  54.  * @method \Aws\Result deleteBucketCors(array $args = [])
  55.  * @method \GuzzleHttp\Promise\Promise deleteBucketCorsAsync(array $args = [])
  56.  * @method \Aws\Result deleteBucketEncryption(array $args = [])
  57.  * @method \GuzzleHttp\Promise\Promise deleteBucketEncryptionAsync(array $args = [])
  58.  * @method \Aws\Result deleteBucketIntelligentTieringConfiguration(array $args = [])
  59.  * @method \GuzzleHttp\Promise\Promise deleteBucketIntelligentTieringConfigurationAsync(array $args = [])
  60.  * @method \Aws\Result deleteBucketInventoryConfiguration(array $args = [])
  61.  * @method \GuzzleHttp\Promise\Promise deleteBucketInventoryConfigurationAsync(array $args = [])
  62.  * @method \Aws\Result deleteBucketLifecycle(array $args = [])
  63.  * @method \GuzzleHttp\Promise\Promise deleteBucketLifecycleAsync(array $args = [])
  64.  * @method \Aws\Result deleteBucketMetadataTableConfiguration(array $args = [])
  65.  * @method \GuzzleHttp\Promise\Promise deleteBucketMetadataTableConfigurationAsync(array $args = [])
  66.  * @method \Aws\Result deleteBucketMetricsConfiguration(array $args = [])
  67.  * @method \GuzzleHttp\Promise\Promise deleteBucketMetricsConfigurationAsync(array $args = [])
  68.  * @method \Aws\Result deleteBucketOwnershipControls(array $args = [])
  69.  * @method \GuzzleHttp\Promise\Promise deleteBucketOwnershipControlsAsync(array $args = [])
  70.  * @method \Aws\Result deleteBucketPolicy(array $args = [])
  71.  * @method \GuzzleHttp\Promise\Promise deleteBucketPolicyAsync(array $args = [])
  72.  * @method \Aws\Result deleteBucketReplication(array $args = [])
  73.  * @method \GuzzleHttp\Promise\Promise deleteBucketReplicationAsync(array $args = [])
  74.  * @method \Aws\Result deleteBucketTagging(array $args = [])
  75.  * @method \GuzzleHttp\Promise\Promise deleteBucketTaggingAsync(array $args = [])
  76.  * @method \Aws\Result deleteBucketWebsite(array $args = [])
  77.  * @method \GuzzleHttp\Promise\Promise deleteBucketWebsiteAsync(array $args = [])
  78.  * @method \Aws\Result deleteObject(array $args = [])
  79.  * @method \GuzzleHttp\Promise\Promise deleteObjectAsync(array $args = [])
  80.  * @method \Aws\Result deleteObjectTagging(array $args = [])
  81.  * @method \GuzzleHttp\Promise\Promise deleteObjectTaggingAsync(array $args = [])
  82.  * @method \Aws\Result deleteObjects(array $args = [])
  83.  * @method \GuzzleHttp\Promise\Promise deleteObjectsAsync(array $args = [])
  84.  * @method \Aws\Result deletePublicAccessBlock(array $args = [])
  85.  * @method \GuzzleHttp\Promise\Promise deletePublicAccessBlockAsync(array $args = [])
  86.  * @method \Aws\Result getBucketAccelerateConfiguration(array $args = [])
  87.  * @method \GuzzleHttp\Promise\Promise getBucketAccelerateConfigurationAsync(array $args = [])
  88.  * @method \Aws\Result getBucketAcl(array $args = [])
  89.  * @method \GuzzleHttp\Promise\Promise getBucketAclAsync(array $args = [])
  90.  * @method \Aws\Result getBucketAnalyticsConfiguration(array $args = [])
  91.  * @method \GuzzleHttp\Promise\Promise getBucketAnalyticsConfigurationAsync(array $args = [])
  92.  * @method \Aws\Result getBucketCors(array $args = [])
  93.  * @method \GuzzleHttp\Promise\Promise getBucketCorsAsync(array $args = [])
  94.  * @method \Aws\Result getBucketEncryption(array $args = [])
  95.  * @method \GuzzleHttp\Promise\Promise getBucketEncryptionAsync(array $args = [])
  96.  * @method \Aws\Result getBucketIntelligentTieringConfiguration(array $args = [])
  97.  * @method \GuzzleHttp\Promise\Promise getBucketIntelligentTieringConfigurationAsync(array $args = [])
  98.  * @method \Aws\Result getBucketInventoryConfiguration(array $args = [])
  99.  * @method \GuzzleHttp\Promise\Promise getBucketInventoryConfigurationAsync(array $args = [])
  100.  * @method \Aws\Result getBucketLifecycle(array $args = [])
  101.  * @method \GuzzleHttp\Promise\Promise getBucketLifecycleAsync(array $args = [])
  102.  * @method \Aws\Result getBucketLifecycleConfiguration(array $args = [])
  103.  * @method \GuzzleHttp\Promise\Promise getBucketLifecycleConfigurationAsync(array $args = [])
  104.  * @method \Aws\Result getBucketLocation(array $args = [])
  105.  * @method \GuzzleHttp\Promise\Promise getBucketLocationAsync(array $args = [])
  106.  * @method \Aws\Result getBucketLogging(array $args = [])
  107.  * @method \GuzzleHttp\Promise\Promise getBucketLoggingAsync(array $args = [])
  108.  * @method \Aws\Result getBucketMetadataTableConfiguration(array $args = [])
  109.  * @method \GuzzleHttp\Promise\Promise getBucketMetadataTableConfigurationAsync(array $args = [])
  110.  * @method \Aws\Result getBucketMetricsConfiguration(array $args = [])
  111.  * @method \GuzzleHttp\Promise\Promise getBucketMetricsConfigurationAsync(array $args = [])
  112.  * @method \Aws\Result getBucketNotification(array $args = [])
  113.  * @method \GuzzleHttp\Promise\Promise getBucketNotificationAsync(array $args = [])
  114.  * @method \Aws\Result getBucketNotificationConfiguration(array $args = [])
  115.  * @method \GuzzleHttp\Promise\Promise getBucketNotificationConfigurationAsync(array $args = [])
  116.  * @method \Aws\Result getBucketOwnershipControls(array $args = [])
  117.  * @method \GuzzleHttp\Promise\Promise getBucketOwnershipControlsAsync(array $args = [])
  118.  * @method \Aws\Result getBucketPolicy(array $args = [])
  119.  * @method \GuzzleHttp\Promise\Promise getBucketPolicyAsync(array $args = [])
  120.  * @method \Aws\Result getBucketPolicyStatus(array $args = [])
  121.  * @method \GuzzleHttp\Promise\Promise getBucketPolicyStatusAsync(array $args = [])
  122.  * @method \Aws\Result getBucketReplication(array $args = [])
  123.  * @method \GuzzleHttp\Promise\Promise getBucketReplicationAsync(array $args = [])
  124.  * @method \Aws\Result getBucketRequestPayment(array $args = [])
  125.  * @method \GuzzleHttp\Promise\Promise getBucketRequestPaymentAsync(array $args = [])
  126.  * @method \Aws\Result getBucketTagging(array $args = [])
  127.  * @method \GuzzleHttp\Promise\Promise getBucketTaggingAsync(array $args = [])
  128.  * @method \Aws\Result getBucketVersioning(array $args = [])
  129.  * @method \GuzzleHttp\Promise\Promise getBucketVersioningAsync(array $args = [])
  130.  * @method \Aws\Result getBucketWebsite(array $args = [])
  131.  * @method \GuzzleHttp\Promise\Promise getBucketWebsiteAsync(array $args = [])
  132.  * @method \Aws\Result getObject(array $args = [])
  133.  * @method \GuzzleHttp\Promise\Promise getObjectAsync(array $args = [])
  134.  * @method \Aws\Result getObjectAcl(array $args = [])
  135.  * @method \GuzzleHttp\Promise\Promise getObjectAclAsync(array $args = [])
  136.  * @method \Aws\Result getObjectAttributes(array $args = [])
  137.  * @method \GuzzleHttp\Promise\Promise getObjectAttributesAsync(array $args = [])
  138.  * @method \Aws\Result getObjectLegalHold(array $args = [])
  139.  * @method \GuzzleHttp\Promise\Promise getObjectLegalHoldAsync(array $args = [])
  140.  * @method \Aws\Result getObjectLockConfiguration(array $args = [])
  141.  * @method \GuzzleHttp\Promise\Promise getObjectLockConfigurationAsync(array $args = [])
  142.  * @method \Aws\Result getObjectRetention(array $args = [])
  143.  * @method \GuzzleHttp\Promise\Promise getObjectRetentionAsync(array $args = [])
  144.  * @method \Aws\Result getObjectTagging(array $args = [])
  145.  * @method \GuzzleHttp\Promise\Promise getObjectTaggingAsync(array $args = [])
  146.  * @method \Aws\Result getObjectTorrent(array $args = [])
  147.  * @method \GuzzleHttp\Promise\Promise getObjectTorrentAsync(array $args = [])
  148.  * @method \Aws\Result getPublicAccessBlock(array $args = [])
  149.  * @method \GuzzleHttp\Promise\Promise getPublicAccessBlockAsync(array $args = [])
  150.  * @method \Aws\Result headBucket(array $args = [])
  151.  * @method \GuzzleHttp\Promise\Promise headBucketAsync(array $args = [])
  152.  * @method \Aws\Result headObject(array $args = [])
  153.  * @method \GuzzleHttp\Promise\Promise headObjectAsync(array $args = [])
  154.  * @method \Aws\Result listBucketAnalyticsConfigurations(array $args = [])
  155.  * @method \GuzzleHttp\Promise\Promise listBucketAnalyticsConfigurationsAsync(array $args = [])
  156.  * @method \Aws\Result listBucketIntelligentTieringConfigurations(array $args = [])
  157.  * @method \GuzzleHttp\Promise\Promise listBucketIntelligentTieringConfigurationsAsync(array $args = [])
  158.  * @method \Aws\Result listBucketInventoryConfigurations(array $args = [])
  159.  * @method \GuzzleHttp\Promise\Promise listBucketInventoryConfigurationsAsync(array $args = [])
  160.  * @method \Aws\Result listBucketMetricsConfigurations(array $args = [])
  161.  * @method \GuzzleHttp\Promise\Promise listBucketMetricsConfigurationsAsync(array $args = [])
  162.  * @method \Aws\Result listBuckets(array $args = [])
  163.  * @method \GuzzleHttp\Promise\Promise listBucketsAsync(array $args = [])
  164.  * @method \Aws\Result listDirectoryBuckets(array $args = [])
  165.  * @method \GuzzleHttp\Promise\Promise listDirectoryBucketsAsync(array $args = [])
  166.  * @method \Aws\Result listMultipartUploads(array $args = [])
  167.  * @method \GuzzleHttp\Promise\Promise listMultipartUploadsAsync(array $args = [])
  168.  * @method \Aws\Result listObjectVersions(array $args = [])
  169.  * @method \GuzzleHttp\Promise\Promise listObjectVersionsAsync(array $args = [])
  170.  * @method \Aws\Result listObjects(array $args = [])
  171.  * @method \GuzzleHttp\Promise\Promise listObjectsAsync(array $args = [])
  172.  * @method \Aws\Result listObjectsV2(array $args = [])
  173.  * @method \GuzzleHttp\Promise\Promise listObjectsV2Async(array $args = [])
  174.  * @method \Aws\Result listParts(array $args = [])
  175.  * @method \GuzzleHttp\Promise\Promise listPartsAsync(array $args = [])
  176.  * @method \Aws\Result putBucketAccelerateConfiguration(array $args = [])
  177.  * @method \GuzzleHttp\Promise\Promise putBucketAccelerateConfigurationAsync(array $args = [])
  178.  * @method \Aws\Result putBucketAcl(array $args = [])
  179.  * @method \GuzzleHttp\Promise\Promise putBucketAclAsync(array $args = [])
  180.  * @method \Aws\Result putBucketAnalyticsConfiguration(array $args = [])
  181.  * @method \GuzzleHttp\Promise\Promise putBucketAnalyticsConfigurationAsync(array $args = [])
  182.  * @method \Aws\Result putBucketCors(array $args = [])
  183.  * @method \GuzzleHttp\Promise\Promise putBucketCorsAsync(array $args = [])
  184.  * @method \Aws\Result putBucketEncryption(array $args = [])
  185.  * @method \GuzzleHttp\Promise\Promise putBucketEncryptionAsync(array $args = [])
  186.  * @method \Aws\Result putBucketIntelligentTieringConfiguration(array $args = [])
  187.  * @method \GuzzleHttp\Promise\Promise putBucketIntelligentTieringConfigurationAsync(array $args = [])
  188.  * @method \Aws\Result putBucketInventoryConfiguration(array $args = [])
  189.  * @method \GuzzleHttp\Promise\Promise putBucketInventoryConfigurationAsync(array $args = [])
  190.  * @method \Aws\Result putBucketLifecycle(array $args = [])
  191.  * @method \GuzzleHttp\Promise\Promise putBucketLifecycleAsync(array $args = [])
  192.  * @method \Aws\Result putBucketLifecycleConfiguration(array $args = [])
  193.  * @method \GuzzleHttp\Promise\Promise putBucketLifecycleConfigurationAsync(array $args = [])
  194.  * @method \Aws\Result putBucketLogging(array $args = [])
  195.  * @method \GuzzleHttp\Promise\Promise putBucketLoggingAsync(array $args = [])
  196.  * @method \Aws\Result putBucketMetricsConfiguration(array $args = [])
  197.  * @method \GuzzleHttp\Promise\Promise putBucketMetricsConfigurationAsync(array $args = [])
  198.  * @method \Aws\Result putBucketNotification(array $args = [])
  199.  * @method \GuzzleHttp\Promise\Promise putBucketNotificationAsync(array $args = [])
  200.  * @method \Aws\Result putBucketNotificationConfiguration(array $args = [])
  201.  * @method \GuzzleHttp\Promise\Promise putBucketNotificationConfigurationAsync(array $args = [])
  202.  * @method \Aws\Result putBucketOwnershipControls(array $args = [])
  203.  * @method \GuzzleHttp\Promise\Promise putBucketOwnershipControlsAsync(array $args = [])
  204.  * @method \Aws\Result putBucketPolicy(array $args = [])
  205.  * @method \GuzzleHttp\Promise\Promise putBucketPolicyAsync(array $args = [])
  206.  * @method \Aws\Result putBucketReplication(array $args = [])
  207.  * @method \GuzzleHttp\Promise\Promise putBucketReplicationAsync(array $args = [])
  208.  * @method \Aws\Result putBucketRequestPayment(array $args = [])
  209.  * @method \GuzzleHttp\Promise\Promise putBucketRequestPaymentAsync(array $args = [])
  210.  * @method \Aws\Result putBucketTagging(array $args = [])
  211.  * @method \GuzzleHttp\Promise\Promise putBucketTaggingAsync(array $args = [])
  212.  * @method \Aws\Result putBucketVersioning(array $args = [])
  213.  * @method \GuzzleHttp\Promise\Promise putBucketVersioningAsync(array $args = [])
  214.  * @method \Aws\Result putBucketWebsite(array $args = [])
  215.  * @method \GuzzleHttp\Promise\Promise putBucketWebsiteAsync(array $args = [])
  216.  * @method \Aws\Result putObject(array $args = [])
  217.  * @method \GuzzleHttp\Promise\Promise putObjectAsync(array $args = [])
  218.  * @method \Aws\Result putObjectAcl(array $args = [])
  219.  * @method \GuzzleHttp\Promise\Promise putObjectAclAsync(array $args = [])
  220.  * @method \Aws\Result putObjectLegalHold(array $args = [])
  221.  * @method \GuzzleHttp\Promise\Promise putObjectLegalHoldAsync(array $args = [])
  222.  * @method \Aws\Result putObjectLockConfiguration(array $args = [])
  223.  * @method \GuzzleHttp\Promise\Promise putObjectLockConfigurationAsync(array $args = [])
  224.  * @method \Aws\Result putObjectRetention(array $args = [])
  225.  * @method \GuzzleHttp\Promise\Promise putObjectRetentionAsync(array $args = [])
  226.  * @method \Aws\Result putObjectTagging(array $args = [])
  227.  * @method \GuzzleHttp\Promise\Promise putObjectTaggingAsync(array $args = [])
  228.  * @method \Aws\Result putPublicAccessBlock(array $args = [])
  229.  * @method \GuzzleHttp\Promise\Promise putPublicAccessBlockAsync(array $args = [])
  230.  * @method \Aws\Result restoreObject(array $args = [])
  231.  * @method \GuzzleHttp\Promise\Promise restoreObjectAsync(array $args = [])
  232.  * @method \Aws\Result selectObjectContent(array $args = [])
  233.  * @method \GuzzleHttp\Promise\Promise selectObjectContentAsync(array $args = [])
  234.  * @method \Aws\Result uploadPart(array $args = [])
  235.  * @method \GuzzleHttp\Promise\Promise uploadPartAsync(array $args = [])
  236.  * @method \Aws\Result uploadPartCopy(array $args = [])
  237.  * @method \GuzzleHttp\Promise\Promise uploadPartCopyAsync(array $args = [])
  238.  * @method \Aws\Result writeGetObjectResponse(array $args = [])
  239.  * @method \GuzzleHttp\Promise\Promise writeGetObjectResponseAsync(array $args = [])
  240.  */
  241. class S3Client extends AwsClient implements S3ClientInterface
  242. {
  243.     private const DIRECTORY_BUCKET_REGEX = '/^[a-zA-Z0-9_-]+--[a-z0-9]+-az\d+--x-s3'
  244.                                             .'(?!.*(?:-s3alias|--ol-s3|\.mrap))$/';
  245.     use S3ClientTrait;
  247.     /** @var array */
  248.     private static $mandatoryAttributes = ['Bucket', 'Key'];
  250.     public static function getArguments()
  251.     {
  252.         $args = parent::getArguments();
  253.         $args['retries']['fn'] = [__CLASS__, '_applyRetryConfig'];
  254.         $args['api_provider']['fn'] = [__CLASS__, '_applyApiProvider'];
  256.         return $args + [
  257.             'bucket_endpoint' => [
  258.                 'type'    => 'config',
  259.                 'valid'   => ['bool'],
  260.                 'doc'     => 'Set to true to send requests to a hardcoded '
  261.                     . 'bucket endpoint rather than create an endpoint as a '
  262.                     . 'result of injecting the bucket into the URL. This '
  263.                     . 'option is useful for interacting with CNAME endpoints.',
  264.             ],
  265.             'use_arn_region' => [
  266.                 'type'    => 'config',
  267.                 'valid'   => [
  268.                     'bool',
  269.                     Configuration::class,
  270.                     CacheInterface::class,
  271.                     'callable'
  272.                 ],
  273.                 'doc'     => 'Set to true to allow passed in ARNs to override'
  274.                     . ' client region. Accepts...',
  275.                 'fn' => [__CLASS__, '_apply_use_arn_region'],
  276.                 'default' => [UseArnRegionConfigurationProvider::class, 'defaultProvider'],
  277.             ],
  278.             'use_accelerate_endpoint' => [
  279.                 'type' => 'config',
  280.                 'valid' => ['bool'],
  281.                 'doc' => 'Set to true to send requests to an S3 Accelerate'
  282.                     . ' endpoint by default. Can be enabled or disabled on'
  283.                     . ' individual operations by setting'
  284.                     . ' \'@use_accelerate_endpoint\' to true or false. Note:'
  285.                     . ' you must enable S3 Accelerate on a bucket before it can'
  286.                     . ' be accessed via an Accelerate endpoint.',
  287.                 'default' => false,
  288.             ],
  289.             'use_path_style_endpoint' => [
  290.                 'type' => 'config',
  291.                 'valid' => ['bool'],
  292.                 'doc' => 'Set to true to send requests to an S3 path style'
  293.                     . ' endpoint by default.'
  294.                     . ' Can be enabled or disabled on individual operations by setting'
  295.                     . ' \'@use_path_style_endpoint\' to true or false.',
  296.                 'default' => false,
  297.             ],
  298.             'disable_multiregion_access_points' => [
  299.                 'type' => 'config',
  300.                 'valid' => ['bool'],
  301.                 'doc' => 'Set to true to disable the usage of'
  302.                     . ' multi region access points. These are enabled by default.'
  303.                     . ' Can be enabled or disabled on individual operations by setting'
  304.                     . ' \'@disable_multiregion_access_points\' to true or false.',
  305.                 'default' => false,
  306.             ],
  307.             'disable_express_session_auth' => [
  308.                 'type' => 'config',
  309.                 'valid' => ['bool'],
  310.                 'doc' => 'Set to true to disable the usage of'
  311.                     . ' s3 express session authentication. This is enabled by default.',
  312.                 'default' => [__CLASS__, '_default_disable_express_session_auth'],
  313.             ],
  314.             's3_express_identity_provider' => [
  315.                 'type'    => 'config',
  316.                 'valid'   => [
  317.                     'bool',
  318.                     'callable'
  319.                 ],
  320.                 'doc'     => 'Specifies the provider used to generate identities to sign s3 express requests.  '
  321.                     . 'Set to `false` to disable s3 express auth, or a callable provider used to create s3 express '
  322.                     . 'identities or return null.',
  323.                 'default' => [__CLASS__, '_default_s3_express_identity_provider'],
  324.             ],
  325.         ];
  326.     }
  328.     /**
  329.      * {@inheritdoc}
  330.      *
  331.      * In addition to the options available to
  332.      * {@see Aws\AwsClient::__construct}, S3Client accepts the following
  333.      * options:
  334.      *
  335.      * - bucket_endpoint: (bool) Set to true to send requests to a
  336.      *   hardcoded bucket endpoint rather than create an endpoint as a result
  337.      *   of injecting the bucket into the URL. This option is useful for
  338.      *   interacting with CNAME endpoints. Note: if you are using version 2.243.0
  339.      *   and above and do not expect the bucket name to appear in the host, you will
  340.      *   also need to set `use_path_style_endpoint` to `true`.
  341.      * - calculate_md5: (bool) Set to false to disable calculating an MD5
  342.      *   for all Amazon S3 signed uploads.
  343.      * - s3_us_east_1_regional_endpoint:
  344.      *   (Aws\S3\RegionalEndpoint\ConfigurationInterface|Aws\CacheInterface\|callable|string|array)
  345.      *   Specifies whether to use regional or legacy endpoints for the us-east-1
  346.      *   region. Provide an Aws\S3\RegionalEndpoint\ConfigurationInterface object, an
  347.      *   instance of Aws\CacheInterface, a callable configuration provider used
  348.      *   to create endpoint configuration, a string value of `legacy` or
  349.      *   `regional`, or an associative array with the following keys:
  350.      *   endpoint_types: (string)  Set to `legacy` or `regional`, defaults to
  351.      *   `legacy`
  352.      * - use_accelerate_endpoint: (bool) Set to true to send requests to an S3
  353.      *   Accelerate endpoint by default. Can be enabled or disabled on
  354.      *   individual operations by setting '@use_accelerate_endpoint' to true or
  355.      *   false. Note: you must enable S3 Accelerate on a bucket before it can be
  356.      *   accessed via an Accelerate endpoint.
  357.      * - use_arn_region: (Aws\S3\UseArnRegion\ConfigurationInterface,
  358.      *   Aws\CacheInterface, bool, callable) Set to true to enable the client
  359.      *   to use the region from a supplied ARN argument instead of the client's
  360.      *   region. Provide an instance of Aws\S3\UseArnRegion\ConfigurationInterface,
  361.      *   an instance of Aws\CacheInterface, a callable that provides a promise for
  362.      *   a Configuration object, or a boolean value. Defaults to false (i.e.
  363.      *   the SDK will not follow the ARN region if it conflicts with the client
  364.      *   region and instead throw an error).
  365.      * - use_dual_stack_endpoint: (bool) Set to true to send requests to an S3
  366.      *   Dual Stack endpoint by default, which enables IPv6 Protocol.
  367.      *   Can be enabled or disabled on individual operations by setting
  368.      *   '@use_dual_stack_endpoint\' to true or false. Note:
  369.      *   you cannot use it together with an accelerate endpoint.
  370.      * - use_path_style_endpoint: (bool) Set to true to send requests to an S3
  371.      *   path style endpoint by default.
  372.      *   Can be enabled or disabled on individual operations by setting
  373.      *   '@use_path_style_endpoint\' to true or false. Note:
  374.      *   you cannot use it together with an accelerate endpoint.
  375.      * - disable_multiregion_access_points: (bool) Set to true to disable
  376.      *   sending multi region requests.  They are enabled by default.
  377.      *   Can be enabled or disabled on individual operations by setting
  378.      *   '@disable_multiregion_access_points\' to true or false. Note:
  379.      *   you cannot use it together with an accelerate or dualstack endpoint.
  380.      *
  381.      * @param array $args
  382.      */
  383.     public function __construct(array $args)
  384.     {
  385.         if (
  386.             !isset($args['s3_us_east_1_regional_endpoint'])
  387.             || $args['s3_us_east_1_regional_endpoint'] instanceof CacheInterface
  388.         ) {
  389.             $args['s3_us_east_1_regional_endpoint'] = ConfigurationProvider::defaultProvider($args);
  390.         }
  391.         $this->addBuiltIns($args);
  392.         parent::__construct($args);
  393.         $stack = $this->getHandlerList();
  394.         $stack->appendInit(SSECMiddleware::wrap($this->getEndpoint()->getScheme()), 's3.ssec');
  395.         $stack->appendBuild(ApplyChecksumMiddleware::wrap($this->getApi()), 's3.checksum');
  396.         $stack->appendBuild(
  397.             Middleware::contentType(['PutObject', 'UploadPart']),
  398.             's3.content_type'
  399.         );
  401.         if ($this->getConfig('bucket_endpoint')) {
  402.             $stack->appendBuild(BucketEndpointMiddleware::wrap(), 's3.bucket_endpoint');
  403.         } elseif (!$this->isUseEndpointV2()) {
  404.             $stack->appendBuild(
  405.                 S3EndpointMiddleware::wrap(
  406.                     $this->getRegion(),
  407.                     $this->getConfig('endpoint_provider'),
  408.                     [
  409.                         'accelerate' => $this->getConfig('use_accelerate_endpoint'),
  410.                         'path_style' => $this->getConfig('use_path_style_endpoint'),
  411.                         'use_fips_endpoint' => $this->getConfig('use_fips_endpoint'),
  412.                         'dual_stack' =>
  413.                             $this->getConfig('use_dual_stack_endpoint')->isUseDualStackEndpoint(),
  415.                     ]
  416.                 ),
  417.                 's3.endpoint_middleware'
  418.             );
  419.         }
  421.         $stack->appendBuild(
  422.             BucketEndpointArnMiddleware::wrap(
  423.                 $this->getApi(),
  424.                 $this->getRegion(),
  425.                 [
  426.                     'use_arn_region' => $this->getConfig('use_arn_region'),
  427.                     'accelerate' => $this->getConfig('use_accelerate_endpoint'),
  428.                     'path_style' => $this->getConfig('use_path_style_endpoint'),
  429.                     'dual_stack' =>
  430.                         $this->getConfig('use_dual_stack_endpoint')->isUseDualStackEndpoint(),
  431.                     'use_fips_endpoint' => $this->getConfig('use_fips_endpoint'),
  432.                     'disable_multiregion_access_points' =>
  433.                         $this->getConfig('disable_multiregion_access_points'),
  434.                     'endpoint' => $args['endpoint'] ?? null
  435.                 ],
  436.                 $this->isUseEndpointV2()
  437.             ),
  438.             's3.bucket_endpoint_arn'
  439.         );
  440.         if ($this->getConfig('disable_express_session_auth')) {
  441.             $stack->prependSign(
  442.                 $this->getDisableExpressSessionAuthMiddleware(),
  443.                 's3.disable_express_session_auth'
  444.             );
  445.         }
  447.         $stack->appendValidate(
  448.             InputValidationMiddleware::wrap($this->getApi(), self::$mandatoryAttributes),
  449.             'input_validation_middleware'
  450.         );
  451.         $stack->appendSign(ExpiresParsingMiddleware::wrap(), 's3.expires_parsing');
  452.         $stack->appendSign(PutObjectUrlMiddleware::wrap(), 's3.put_object_url');
  453.         $stack->appendSign(PermanentRedirectMiddleware::wrap(), 's3.permanent_redirect');
  454.         $stack->appendInit(Middleware::sourceFile($this->getApi()), 's3.source_file');
  455.         $stack->appendInit($this->getSaveAsParameter(), 's3.save_as');
  456.         $stack->appendInit($this->getLocationConstraintMiddleware(), 's3.location');
  457.         $stack->appendInit($this->getEncodingTypeMiddleware(), 's3.auto_encode');
  458.         $stack->appendInit($this->getHeadObjectMiddleware(), 's3.head_object');
  459.         $this->processModel($this->isUseEndpointV2());
  460.         if ($this->isUseEndpointV2()) {
  461.             $stack->after('builder',
  462.                 's3.check_empty_path_with_query',
  463.                 $this->getEmptyPathWithQuery());
  464.         }
  465.     }
  467.     /**
  468.      * Determine if a string is a valid name for a DNS compatible Amazon S3
  469.      * bucket.
  470.      *
  471.      * DNS compatible bucket names can be used as a subdomain in a URL (e.g.,
  472.      * "<bucket>.s3.amazonaws.com").
  473.      *
  474.      * @param string $bucket Bucket name to check.
  475.      *
  476.      * @return bool
  477.      */
  478.     public static function isBucketDnsCompatible($bucket)
  479.     {
  480.         if (!is_string($bucket)) {
  481.             return false;
  482.         }
  483.         $bucketLen = strlen($bucket);
  485.         return ($bucketLen >= 3 && $bucketLen <= 63) &&
  486.             // Cannot look like an IP address
  487.             !filter_var($bucket, FILTER_VALIDATE_IP) &&
  488.             preg_match('/^[a-z0-9]([a-z0-9\-\.]*[a-z0-9])?$/', $bucket);
  489.     }
  491.     public static function _apply_use_arn_region($value, array &$args, HandlerList $list)
  492.     {
  493.         if ($value instanceof CacheInterface) {
  494.             $value = UseArnRegionConfigurationProvider::defaultProvider($args);
  495.         }
  496.         if (is_callable($value)) {
  497.             $value = $value();
  498.         }
  499.         if ($value instanceof PromiseInterface) {
  500.             $value = $value->wait();
  501.         }
  502.         if ($value instanceof ConfigurationInterface) {
  503.             $args['use_arn_region'] = $value;
  504.         } else {
  505.             // The Configuration class itself will validate other inputs
  506.             $args['use_arn_region'] = new Configuration($value);
  507.         }
  508.     }
  510.     public function createPresignedRequest(CommandInterface $command, $expires, array $options = [])
  511.     {
  512.         $command = clone $command;
  513.         $command->getHandlerList()->remove('signer');
  514.         $request = \Aws\serialize($command);
  515.         $signing_name = $command['@context']['signing_service']
  516.             ?? $this->getSigningName($request->getUri()->getHost());
  517.         $signature_version = $this->getSignatureVersionFromCommand($command);
  519.         /** @var \Aws\Signature\SignatureInterface $signer */
  520.         $signer = call_user_func(
  521.             $this->getSignatureProvider(),
  522.             $signature_version,
  523.             $signing_name,
  524.             $this->getConfig('signing_region')
  525.         );
  526.         if ($signature_version == 'v4-s3express') {
  527.             $provider = $this->getConfig('s3_express_identity_provider');
  528.             $credentials = $provider($command)->wait();
  529.         } else {
  530.             $credentials = $this->getCredentials()->wait();
  531.         }
  532.         return $signer->presign(
  533.             $request,
  534.             $credentials,
  535.             $expires,
  536.             $options
  537.         );
  538.     }
  540.     /**
  541.      * Returns the URL to an object identified by its bucket and key.
  542.      *
  543.      * The URL returned by this method is not signed nor does it ensure that the
  544.      * bucket and key given to the method exist. If you need a signed URL, then
  545.      * use the {@see \Aws\S3\S3Client::createPresignedRequest} method and get
  546.      * the URI of the signed request.
  547.      *
  548.      * @param string $bucket  The name of the bucket where the object is located
  549.      * @param string $key     The key of the object
  550.      *
  551.      * @return string The URL to the object
  552.      */
  553.     public function getObjectUrl($bucket, $key)
  554.     {
  555.         $command = $this->getCommand('GetObject', [
  556.             'Bucket' => $bucket,
  557.             'Key'    => $key
  558.         ]);
  560.         return (string) \Aws\serialize($command)->getUri();
  561.     }
  563.     /**
  564.      * Raw URL encode a key and allow for '/' characters
  565.      *
  566.      * @param string $key Key to encode
  567.      *
  568.      * @return string Returns the encoded key
  569.      */
  570.     public static function encodeKey($key)
  571.     {
  572.         return str_replace('%2F', '/', rawurlencode($key));
  573.     }
  575.     /**
  576.      * Provides a middleware that removes the need to specify LocationConstraint on CreateBucket.
  577.      *
  578.      * @return \Closure
  579.      */
  580.     private function getLocationConstraintMiddleware()
  581.     {
  582.         $region = $this->getRegion();
  583.         return static function (callable $handler) use ($region) {
  584.             return function (Command $command, $request = null) use ($handler, $region) {
  585.                 if ($command->getName() === 'CreateBucket'
  586.                     && !self::isDirectoryBucket($command['Bucket'])
  587.                 ) {
  588.                     $locationConstraint = $command['CreateBucketConfiguration']['LocationConstraint']
  589.                         ?? null;
  591.                     if ($locationConstraint === 'us-east-1') {
  592.                         unset($command['CreateBucketConfiguration']);
  593.                     } elseif ('us-east-1' !== $region && empty($locationConstraint)) {
  594.                         if (isset($command['CreateBucketConfiguration'])) {
  595.                             $command['CreateBucketConfiguration']['LocationConstraint'] = $region;
  596.                         } else {
  597.                             $command['CreateBucketConfiguration'] = ['LocationConstraint' => $region];
  598.                         }
  599.                     }
  600.                 }
  602.                 return $handler($command, $request);
  603.             };
  604.         };
  605.     }
  607.     /**
  608.      * Provides a middleware that supports the `SaveAs` parameter.
  609.      *
  610.      * @return \Closure
  611.      */
  612.     private function getSaveAsParameter()
  613.     {
  614.         return static function (callable $handler) {
  615.             return function (Command $command, $request = null) use ($handler) {
  616.                 if ($command->getName() === 'GetObject' && isset($command['SaveAs'])) {
  617.                     $command['@http']['sink'] = $command['SaveAs'];
  618.                     unset($command['SaveAs']);
  619.                 }
  621.                 return $handler($command, $request);
  622.             };
  623.         };
  624.     }
  626.     /**
  627.      * Provides a middleware that disables content decoding on HeadObject
  628.      * commands.
  629.      *
  630.      * @return \Closure
  631.      */
  632.     private function getHeadObjectMiddleware()
  633.     {
  634.         return static function (callable $handler) {
  635.             return function (
  636.                 CommandInterface $command,
  637.                 ?RequestInterface $request = null
  638.             ) use ($handler) {
  639.                 if ($command->getName() === 'HeadObject'
  640.                     && !isset($command['@http']['decode_content'])
  641.                 ) {
  642.                     $command['@http']['decode_content'] = false;
  643.                 }
  645.                 return $handler($command, $request);
  646.             };
  647.         };
  648.     }
  650.     /**
  651.      * Provides a middleware that autopopulates the EncodingType parameter on
  652.      * ListObjects commands.
  653.      *
  654.      * @return \Closure
  655.      */
  656.     private function getEncodingTypeMiddleware()
  657.     {
  658.         return static function (callable $handler) {
  659.             return function (Command $command, $request = null) use ($handler) {
  660.                 $autoSet = false;
  661.                 if ($command->getName() === 'ListObjects'
  662.                     && empty($command['EncodingType'])
  663.                 ) {
  664.                     $command['EncodingType'] = 'url';
  665.                     $autoSet = true;
  666.                 }
  668.                 return $handler($command, $request)
  669.                     ->then(function (ResultInterface $result) use ($autoSet) {
  670.                         if ($result['EncodingType'] === 'url' && $autoSet) {
  671.                             static $topLevel = [
  672.                                 'Delimiter',
  673.                                 'Marker',
  674.                                 'NextMarker',
  675.                                 'Prefix',
  676.                             ];
  677.                             static $nested = [
  678.                                 ['Contents', 'Key'],
  679.                                 ['CommonPrefixes', 'Prefix'],
  680.                             ];
  682.                             foreach ($topLevel as $key) {
  683.                                 if (isset($result[$key])) {
  684.                                     $result[$key] = urldecode($result[$key]);
  685.                                 }
  686.                             }
  687.                             foreach ($nested as $steps) {
  688.                                 if (isset($result[$steps[0]])) {
  689.                                     foreach ($result[$steps[0]] as $key => $part) {
  690.                                         if (isset($part[$steps[1]])) {
  691.                                             $result[$steps[0]][$key][$steps[1]]
  692.                                                 = urldecode($part[$steps[1]]);
  693.                                         }
  694.                                     }
  695.                                 }
  696.                             }
  698.                         }
  700.                         return $result;
  701.                     });
  702.             };
  703.         };
  704.     }
  706.     /**
  707.      * Provides a middleware that checks for an empty path and a
  708.      * non-empty query string.
  709.      *
  710.      * @return \Closure
  711.      */
  712.     private function getEmptyPathWithQuery()
  713.     {
  714.         return static function (callable $handler) {
  715.             return function (Command $command, RequestInterface $request) use ($handler) {
  716.                 $uri = $request->getUri();
  717.                 if (empty($uri->getPath()) && !empty($uri->getQuery())) {
  718.                     $uri = $uri->withPath('/');
  719.                     $request = $request->withUri($uri);
  720.                 }
  722.                 return $handler($command, $request);
  723.             };
  724.         };
  725.     }
  727.     /**
  728.      * Provides a middleware that disables express session auth when
  729.      * customers opt out of it.
  730.      *
  731.      * @return \Closure
  732.      */
  733.     private function getDisableExpressSessionAuthMiddleware()
  734.     {
  735.         return function (callable $handler) {
  736.             return function (
  737.                 CommandInterface $command,
  738.                 ?RequestInterface $request = null
  739.             ) use ($handler) {
  740.                 if (!empty($command['@context']['signature_version'])
  741.                     && $command['@context']['signature_version'] === 'v4-s3express'
  742.                 ) {
  743.                     $command['@context']['signature_version'] = 's3v4';
  744.                 }
  745.                 return $handler($command, $request);
  746.             };
  747.         };
  748.     }
  750.     /**
  751.      * Special handling for when the service name is s3-object-lambda.
  752.      * So, if the host contains s3-object-lambda, then the service name
  753.      * returned is s3-object-lambda, otherwise the default signing service is returned.
  754.      * @param string $host The host to validate if is a s3-object-lambda URL.
  755.      * @return string returns the signing service name to be used
  756.      */
  757.     private function getSigningName($host)
  758.     {
  759.         if (strpos( $host, 's3-object-lambda')) {
  760.             return 's3-object-lambda';
  761.         }
  763.         return $this->getConfig('signing_name');
  764.     }
  766.     public static function _default_disable_express_session_auth(array &$args) {
  767.         return ConfigurationResolver::resolve(
  768.             's3_disable_express_session_auth',
  769.             false,
  770.             'bool',
  771.             $args
  772.         );
  773.     }
  775.     public static function _default_s3_express_identity_provider(array $args)
  776.     {
  777.         if ($args['config']['disable_express_session_auth']) {
  778.             return false;
  779.         }
  780.         return new S3ExpressIdentityProvider($args['region']);
  781.     }
  783.     /**
  784.      * If EndpointProviderV2 is used, removes `Bucket` from request URIs.
  785.      * This is now handled by the endpoint ruleset.
  786.      *
  787.      * Additionally adds a synthetic shape `ExpiresString` and modifies
  788.      * `Expires` type to ensure it remains set to `timestamp`.
  789.      *
  790.      * @param array $args
  791.      * @return void
  792.      *
  793.      * @internal
  794.      */
  795.     private function processModel(bool $isUseEndpointV2): void
  796.     {
  797.         $definition = $this->getApi()->getDefinition();
  799.         if ($isUseEndpointV2) {
  800.             foreach($definition['operations'] as &$operation) {
  801.                 if (isset($operation['http']['requestUri'])) {
  802.                     $requestUri = $operation['http']['requestUri'];
  803.                     if ($requestUri === "/{Bucket}") {
  804.                         $requestUri = str_replace('/{Bucket}', '/', $requestUri);
  805.                     } else {
  806.                         $requestUri = str_replace('/{Bucket}', '', $requestUri);
  807.                     }
  808.                     $operation['http']['requestUri'] = $requestUri;
  809.                 }
  810.             }
  811.         }
  813.         foreach ($definition['shapes'] as $key => &$value) {
  814.             $suffix = 'Output';
  815.             if (substr($key, -strlen($suffix)) === $suffix) {
  816.                 if (isset($value['members']['Expires'])) {
  817.                     $value['members']['Expires']['deprecated'] = true;
  818.                     $value['members']['ExpiresString'] = [
  819.                         'shape' => 'ExpiresString',
  820.                         'location' => 'header',
  821.                         'locationName' => 'Expires'
  822.                     ];
  823.                 }
  824.             }
  825.         }
  826.         $definition['shapes']['ExpiresString']['type'] = 'string';
  827.         $definition['shapes']['Expires']['type'] = 'timestamp';
  829.         $this->getApi()->setDefinition($definition);
  830.     }
  832.     /**
  833.      * Adds service-specific client built-in values
  834.      *
  835.      * @return void
  836.      */
  837.     private function addBuiltIns($args)
  838.     {
  839.         if (isset($args['region'])
  840.             && $args['region'] !== 'us-east-1'
  841.         ) {
  842.             return false;
  843.         }
  845.         if (!isset($args['region'])
  846.             && ConfigurationResolver::resolve('region', '', 'string') !== 'us-east-1'
  847.         ) {
  848.             return false;
  849.         }
  851.         $key = 'AWS::S3::UseGlobalEndpoint';
  852.         $result = $args['s3_us_east_1_regional_endpoint'] instanceof \Closure ?
  853.             $args['s3_us_east_1_regional_endpoint']()->wait() : $args['s3_us_east_1_regional_endpoint'];
  855.         if (is_string($result)) {
  856.             if ($result === 'regional') {
  857.                 $value = false;
  858.             } else if ($result === 'legacy') {
  859.                 $value = true;
  860.             } else {
  861.                 return;
  862.             }
  863.         } else {
  864.             if ($result->isFallback()
  865.                 || $result->getEndpointsType() === 'legacy'
  866.             ) {
  867.                 $value = true;
  868.             } else {
  869.                 $value = false;
  870.             }
  871.         }
  872.         $this->clientBuiltIns[$key] = $value;
  873.     }
  875.     /**
  876.      * Determines whether a bucket is a directory bucket.
  877.      * Only considers the availability zone/suffix format
  878.      *
  879.      * @param string $bucket
  880.      * @return bool
  881.      */
  882.     public static function isDirectoryBucket(string $bucket): bool
  883.     {
  884.         return preg_match(self::DIRECTORY_BUCKET_REGEX, $bucket) === 1;
  885.     }
  887.     /** @internal */
  888.     public static function _applyRetryConfig($value, $args, HandlerList $list)
  889.     {
  890.         if ($value) {
  891.             $config = \Aws\Retry\ConfigurationProvider::unwrap($value);
  893.             if ($config->getMode() === 'legacy') {
  894.                 $maxRetries = $config->getMaxAttempts() - 1;
  895.                 $decider = RetryMiddleware::createDefaultDecider($maxRetries);
  896.                 $decider = function ($retries, $command, $request, $result, $error) use ($decider, $maxRetries) {
  897.                     $maxRetries = $command['@retries'] ?? $maxRetries;
  899.                     if ($decider($retries, $command, $request, $result, $error)) {
  900.                         return true;
  901.                     }
  903.                     if ($error instanceof AwsException
  904.                         && $retries < $maxRetries
  905.                     ) {
  906.                         if ($error->getResponse()
  907.                             && $error->getResponse()->getStatusCode() >= 400
  908.                         ) {
  909.                             return strpos(
  910.                                     $error->getResponse()->getBody(),
  911.                                     'Your socket connection to the server'
  912.                                 ) !== false;
  913.                         }
  915.                         if ($error->getPrevious() instanceof RequestException) {
  916.                             // All commands except CompleteMultipartUpload are
  917.                             // idempotent and may be retried without worry if a
  918.                             // networking error has occurred.
  919.                             return $command->getName() !== 'CompleteMultipartUpload';
  920.                         }
  921.                     }
  923.                     return false;
  924.                 };
  926.                 $delay = [RetryMiddleware::class, 'exponentialDelay'];
  927.                 $list->appendSign(Middleware::retry($decider, $delay), 'retry');
  928.             } else {
  929.                 $defaultDecider = RetryMiddlewareV2::createDefaultDecider(
  930.                     new QuotaManager(),
  931.                     $config->getMaxAttempts()
  932.                 );
  934.                 $list->appendSign(
  935.                     RetryMiddlewareV2::wrap(
  936.                         $config,
  937.                         [
  938.                             'collect_stats' => $args['stats']['retries'],
  939.                             'decider' => function(
  940.                                 $attempts,
  941.                                 CommandInterface $cmd,
  942.                                 $result
  943.                             ) use ($defaultDecider, $config) {
  944.                                 $isRetryable = $defaultDecider($attempts, $cmd, $result);
  945.                                 if (!$isRetryable
  946.                                     && $result instanceof AwsException
  947.                                     && $attempts < $config->getMaxAttempts()
  948.                                 ) {
  949.                                     if (!empty($result->getResponse())
  950.                                         && $result->getResponse()->getStatusCode() >= 400
  951.                                     ) {
  952.                                         return strpos(
  953.                                                 $result->getResponse()->getBody(),
  954.                                                 'Your socket connection to the server'
  955.                                             ) !== false;
  956.                                     }
  958.                                     if ($result->getPrevious() instanceof RequestException
  959.                                         && $cmd->getName() !== 'CompleteMultipartUpload'
  960.                                     ) {
  961.                                         $isRetryable = true;
  962.                                     }
  963.                                 }
  965.                                 return $isRetryable;
  966.                             }
  967.                         ]
  968.                     ),
  969.                     'retry'
  970.                 );
  971.             }
  972.         }
  973.     }
  975.     /** @internal */
  976.     public static function _applyApiProvider($value, array &$args, HandlerList $list)
  977.     {
  978.         ClientResolver::_apply_api_provider($value, $args);
  979.         $s3Parser = new S3Parser(
  980.             $args['parser'],
  981.             $args['error_parser'],
  982.             $args['api'],
  983.             $args['exception_class']
  984.         );
  985.         $s3Parser->addS3ResultMutator(
  986.             'get-bucket-location',
  987.             new GetBucketLocationResultMutator()
  988.         );
  989.         $s3Parser->addS3ResultMutator(
  990.             'validate-response-checksum',
  991.             new ValidateResponseChecksumResultMutator($args['api'])
  992.         );
  993.         $args['parser'] = $s3Parser;
  994.     }
  996.     /**
  997.      * @internal
  998.      * @codeCoverageIgnore
  999.      */
  1000.     public static function applyDocFilters(array $api, array $docs)
  1001.     {
  1002.         $b64 = '<div class="alert alert-info">This value will be base64 encoded on your behalf.</div>';
  1003.         $opt = '<div class="alert alert-info">This value will be computed for you it is not supplied.</div>';
  1005.         // Add a note on the CopyObject docs
  1006.          $s3ExceptionRetryMessage = "<p>Additional info on response behavior: if there is"
  1007.             . " an internal error in S3 after the request was successfully recieved,"
  1008.             . " a 200 response will be returned with an <code>S3Exception</code> embedded"
  1009.             . " in it; this will still be caught and retried by"
  1010.             . " <code>RetryMiddleware.</code></p>";
  1012.         $docs['operations']['CopyObject'] .=  $s3ExceptionRetryMessage;
  1013.         $docs['operations']['CompleteMultipartUpload'] .=  $s3ExceptionRetryMessage;
  1014.         $docs['operations']['UploadPartCopy'] .=  $s3ExceptionRetryMessage;
  1015.         $docs['operations']['UploadPart'] .=  $s3ExceptionRetryMessage;
  1017.         // Add note about stream ownership in the putObject call
  1018.         $guzzleStreamMessage = "<p>Additional info on behavior of the stream"
  1019.             . " parameters: Psr7 takes ownership of streams and will automatically close"
  1020.             . " streams when this method is called with a stream as the <code>Body</code>"
  1021.             . " parameter.  To prevent this, set the <code>Body</code> using"
  1022.             . " <code>GuzzleHttp\Psr7\stream_for</code> method with a is an instance of"
  1023.             . " <code>Psr\Http\Message\StreamInterface</code>, and it will be returned"
  1024.             . " unmodified. This will allow you to keep the stream in scope. </p>";
  1025.         $docs['operations']['PutObject'] .=  $guzzleStreamMessage;
  1027.         // Add the SourceFile parameter.
  1028.         $docs['shapes']['SourceFile']['base'] = 'The path to a file on disk to use instead of the Body parameter.';
  1029.         $api['shapes']['SourceFile'] = ['type' => 'string'];
  1030.         $api['shapes']['PutObjectRequest']['members']['SourceFile'] = ['shape' => 'SourceFile'];
  1031.         $api['shapes']['UploadPartRequest']['members']['SourceFile'] = ['shape' => 'SourceFile'];
  1033.         // Add the ContentSHA256 parameter.
  1034.         $docs['shapes']['ContentSHA256']['base'] = 'A SHA256 hash of the body content of the request.';
  1035.         $api['shapes']['ContentSHA256'] = ['type' => 'string'];
  1036.         $api['shapes']['PutObjectRequest']['members']['ContentSHA256'] = ['shape' => 'ContentSHA256'];
  1037.         $api['shapes']['UploadPartRequest']['members']['ContentSHA256'] = ['shape' => 'ContentSHA256'];
  1038.         $docs['shapes']['ContentSHA256']['append'] = $opt;
  1040.         // Add the AddContentMD5 parameter.
  1041.         $docs['shapes']['AddContentMD5']['base'] = 'Set to true to calculate the ContentMD5 for the upload.';
  1042.         $api['shapes']['AddContentMD5'] = ['type' => 'boolean'];
  1043.         $api['shapes']['PutObjectRequest']['members']['AddContentMD5'] = ['shape' => 'AddContentMD5'];
  1044.         $api['shapes']['UploadPartRequest']['members']['AddContentMD5'] = ['shape' => 'AddContentMD5'];
  1046.         // Add the SaveAs parameter.
  1047.         $docs['shapes']['SaveAs']['base'] = 'The path to a file on disk to save the object data.';
  1048.         $api['shapes']['SaveAs'] = ['type' => 'string'];
  1049.         $api['shapes']['GetObjectRequest']['members']['SaveAs'] = ['shape' => 'SaveAs'];
  1051.         // Several SSECustomerKey documentation updates.
  1052.         $docs['shapes']['SSECustomerKey']['append'] = $b64;
  1053.         $docs['shapes']['CopySourceSSECustomerKey']['append'] = $b64;
  1054.         $docs['shapes']['SSECustomerKeyMd5']['append'] = $opt;
  1056.         // Add the ObjectURL to various output shapes and documentation.
  1057.         $docs['shapes']['ObjectURL']['base'] = 'The URI of the created object.';
  1058.         $api['shapes']['ObjectURL'] = ['type' => 'string'];
  1059.         $api['shapes']['PutObjectOutput']['members']['ObjectURL'] = ['shape' => 'ObjectURL'];
  1060.         $api['shapes']['CopyObjectOutput']['members']['ObjectURL'] = ['shape' => 'ObjectURL'];
  1061.         $api['shapes']['CompleteMultipartUploadOutput']['members']['ObjectURL'] = ['shape' => 'ObjectURL'];
  1063.         // Fix references to Location Constraint.
  1064.         unset($api['shapes']['CreateBucketRequest']['payload']);
  1065.         $api['shapes']['BucketLocationConstraint']['enum'] = [
  1066.             "ap-northeast-1",
  1067.             "ap-southeast-2",
  1068.             "ap-southeast-1",
  1069.             "cn-north-1",
  1070.             "eu-central-1",
  1071.             "eu-west-1",
  1072.             "us-east-1",
  1073.             "us-west-1",
  1074.             "us-west-2",
  1075.             "sa-east-1",
  1076.         ];
  1078.         // Add a note that the ContentMD5 is automatically computed, except for with PutObject and UploadPart
  1079.         $docs['shapes']['ContentMD5']['append'] = '<div class="alert alert-info">The value will be computed on '
  1080.             . 'your behalf.</div>';
  1081.         $docs['shapes']['ContentMD5']['excludeAppend'] = ['PutObjectRequest', 'UploadPartRequest'];
  1083.         //Add a note to ContentMD5 for PutObject and UploadPart that specifies the value is required
  1084.         // When uploading to a bucket with object lock enabled and that it is not computed automatically
  1085.         $objectLock = '<div class="alert alert-info">This value is required if uploading to a bucket '
  1086.             . 'which has Object Lock enabled. It will not be calculated for you automatically. If you wish to have '
  1087.             . 'the value calculated for you, use the `AddContentMD5` parameter.</div>';
  1088.         $docs['shapes']['ContentMD5']['appendOnly'] = [
  1089.             'message' => $objectLock,
  1090.             'shapes' => ['PutObjectRequest', 'UploadPartRequest']
  1091.         ];
  1093.         // Add `ExpiresString` shape to output structures which contain `Expires`
  1094.         // Deprecate existing `Expires` shapes in output structures
  1095.         // Add/Update documentation for both `ExpiresString` and `Expires`
  1096.         // Ensure `Expires` type remains timestamp
  1097.         foreach ($api['shapes'] as $key => &$value) {
  1098.             $suffix = 'Output';
  1099.             if (substr($key, -strlen($suffix)) === $suffix) {
  1100.                 if (isset($value['members']['Expires'])) {
  1101.                     $value['members']['Expires']['deprecated'] = true;
  1102.                     $value['members']['ExpiresString'] = [
  1103.                         'shape' => 'ExpiresString',
  1104.                         'location' => 'header',
  1105.                         'locationName' => 'Expires'
  1106.                     ];
  1107.                     $docs['shapes']['Expires']['refs'][$key . '$Expires']
  1108.                         .= '<p>This output shape has been deprecated. Please refer to <code>ExpiresString</code> instead.</p>.';
  1109.                 }
  1110.             }
  1111.         }
  1112.         $api['shapes']['ExpiresString']['type'] = 'string';
  1113.         $docs['shapes']['ExpiresString']['base'] = 'The unparsed string value of the <code>Expires</code> output member.';
  1114.         $api['shapes']['Expires']['type'] = 'timestamp';
  1116.         return [
  1117.             new Service($api, ApiProvider::defaultProvider()),
  1118.             new DocModel($docs)
  1119.         ];
  1120.     }
  1122.     /**
  1123.      * @internal
  1124.      * @codeCoverageIgnore
  1125.      */
  1126.     public static function addDocExamples($examples)
  1127.     {
  1128.         $getObjectExample = [
  1129.             'input' => [
  1130.                 'Bucket' => 'arn:aws:s3:us-east-1:123456789012:accesspoint:myaccesspoint',
  1131.                 'Key' => 'my-key'
  1132.             ],
  1133.             'output' => [
  1134.                 'Body' => 'class GuzzleHttp\Psr7\Stream#208 (7) {...}',
  1135.                 'ContentLength' => '11',
  1136.                 'ContentType' => 'application/octet-stream',
  1137.             ],
  1138.             'comments' => [
  1139.                 'input' => '',
  1140.                 'output' => 'Simplified example output'
  1141.             ],
  1142.             'description' => 'The following example retrieves an object by referencing the bucket via an S3 accesss point ARN. Result output is simplified for the example.',
  1143.             'id' => '',
  1144.             'title' => 'To get an object via an S3 access point ARN'
  1145.         ];
  1146.         if (isset($examples['GetObject'])) {
  1147.             $examples['GetObject'] []= $getObjectExample;
  1148.         } else {
  1149.             $examples['GetObject'] = [$getObjectExample];
  1150.         }
  1152.         $putObjectExample = [
  1153.             'input' => [
  1154.                 'Bucket' => 'arn:aws:s3:us-east-1:123456789012:accesspoint:myaccesspoint',
  1155.                 'Key' => 'my-key',
  1156.                 'Body' => 'my-body',
  1157.             ],
  1158.             'output' => [
  1159.                 'ObjectURL' => 'https://my-bucket.s3.us-east-1.amazonaws.com/my-key'
  1160.             ],
  1161.             'comments' => [
  1162.                 'input' => '',
  1163.                 'output' => 'Simplified example output'
  1164.             ],
  1165.             'description' => 'The following example uploads an object by referencing the bucket via an S3 accesss point ARN. Result output is simplified for the example.',
  1166.             'id' => '',
  1167.             'title' => 'To upload an object via an S3 access point ARN'
  1168.         ];
  1169.         if (isset($examples['PutObject'])) {
  1170.             $examples['PutObject'] []= $putObjectExample;
  1171.         } else {
  1172.             $examples['PutObject'] = [$putObjectExample];
  1173.         }
  1175.         return $examples;
  1176.     }
  1178.     /**
  1179.      * @param CommandInterface $command
  1180.      * @return array|mixed|null
  1181.      */
  1182.     private function getSignatureVersionFromCommand(CommandInterface $command)
  1183.     {
  1184.         return $command['@context']['signature_version']
  1185.             ?? $this->getConfig('signature_version');
  1186.     }
  1187. }