@pgarbe/cdk-ecr-sync 0.5.25 → 0.5.28
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.gitattributes +0 -1
- package/.jsii +149 -6
- package/.projenrc.ts +6 -4
- package/CHANGELOG.md +1 -1
- package/lib/ecr-sync.d.ts +5 -22
- package/lib/ecr-sync.d.ts.map +1 -0
- package/lib/ecr-sync.js +3 -10
- package/lib/image.d.ts +6 -8
- package/lib/image.d.ts.map +1 -0
- package/lib/image.js +1 -1
- package/lib/index.d.ts +1 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/lambda/docker-adapter.d.ts +1 -0
- package/lib/lambda/docker-adapter.d.ts.map +1 -0
- package/lib/lambda/ecr-adapter.d.ts +1 -0
- package/lib/lambda/ecr-adapter.d.ts.map +1 -0
- package/lib/lambda/get-image-tags-handler.d.ts +1 -0
- package/lib/lambda/get-image-tags-handler.d.ts.map +1 -0
- package/node_modules/aws-sdk/CHANGELOG.md +433 -1
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/acm-pca-2017-08-22.min.json +56 -25
- package/node_modules/aws-sdk/apis/amplify-2017-07-25.min.json +68 -50
- package/node_modules/aws-sdk/apis/amplifybackend-2020-08-11.min.json +47 -7
- package/node_modules/aws-sdk/apis/amplifyuibuilder-2021-08-11.min.json +144 -65
- package/node_modules/aws-sdk/apis/amplifyuibuilder-2021-08-11.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/apigateway-2015-07-09.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/appconfig-2019-10-09.min.json +3 -1
- package/node_modules/aws-sdk/apis/appconfigdata-2021-11-11.min.json +11 -11
- package/node_modules/aws-sdk/apis/appflow-2020-08-23.min.json +739 -235
- package/node_modules/aws-sdk/apis/appflow-2020-08-23.paginators.json +7 -1
- package/node_modules/aws-sdk/apis/apprunner-2020-05-15.min.json +350 -32
- package/node_modules/aws-sdk/apis/apprunner-2020-05-15.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/appstream-2016-12-01.min.json +9 -0
- package/node_modules/aws-sdk/apis/athena-2017-05-18.min.json +90 -31
- package/node_modules/aws-sdk/apis/auditmanager-2017-07-25.min.json +5 -1
- package/node_modules/aws-sdk/apis/autoscaling-2011-01-01.examples.json +31 -46
- package/node_modules/aws-sdk/apis/autoscaling-2011-01-01.min.json +113 -90
- package/node_modules/aws-sdk/apis/backup-2018-11-15.min.json +30 -0
- package/node_modules/aws-sdk/apis/backup-2018-11-15.paginators.json +22 -11
- package/node_modules/aws-sdk/apis/batch-2016-08-10.min.json +143 -94
- package/node_modules/aws-sdk/apis/billingconductor-2021-07-30.examples.json +5 -0
- package/node_modules/aws-sdk/apis/billingconductor-2021-07-30.min.json +1374 -0
- package/node_modules/aws-sdk/apis/billingconductor-2021-07-30.paginators.json +62 -0
- package/node_modules/aws-sdk/apis/billingconductor-2021-07-30.waiters2.json +4 -0
- package/node_modules/aws-sdk/apis/braket-2019-09-01.min.json +30 -27
- package/node_modules/aws-sdk/apis/budgets-2016-10-20.min.json +107 -45
- package/node_modules/aws-sdk/apis/budgets-2016-10-20.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/ce-2017-10-25.min.json +206 -125
- package/node_modules/aws-sdk/apis/chime-2018-05-01.min.json +3 -0
- package/node_modules/aws-sdk/apis/chime-sdk-media-pipelines-2021-07-15.examples.json +5 -0
- package/node_modules/aws-sdk/apis/chime-sdk-media-pipelines-2021-07-15.min.json +330 -0
- package/node_modules/aws-sdk/apis/chime-sdk-media-pipelines-2021-07-15.paginators.json +9 -0
- package/node_modules/aws-sdk/apis/chime-sdk-meetings-2021-07-15.min.json +16 -11
- package/node_modules/aws-sdk/apis/cloudcontrol-2021-09-30.paginators.json +4 -2
- package/node_modules/aws-sdk/apis/cloudcontrol-2021-09-30.waiters2.json +23 -27
- package/node_modules/aws-sdk/apis/cloudformation-2010-05-15.min.json +86 -25
- package/node_modules/aws-sdk/apis/cloudfront-2020-05-31.min.json +42 -28
- package/node_modules/aws-sdk/apis/cloudtrail-2013-11-01.min.json +25 -2
- package/node_modules/aws-sdk/apis/codeguru-reviewer-2019-09-19.min.json +15 -8
- package/node_modules/aws-sdk/apis/codeguru-reviewer-2019-09-19.waiters2.json +14 -2
- package/node_modules/aws-sdk/apis/cognito-idp-2016-04-18.min.json +119 -118
- package/node_modules/aws-sdk/apis/comprehend-2017-11-27.min.json +308 -79
- package/node_modules/aws-sdk/apis/comprehend-2017-11-27.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/config-2014-11-12.min.json +217 -113
- package/node_modules/aws-sdk/apis/connect-2017-08-08.min.json +832 -139
- package/node_modules/aws-sdk/apis/connect-2017-08-08.paginators.json +33 -0
- package/node_modules/aws-sdk/apis/customer-profiles-2020-08-15.min.json +537 -200
- package/node_modules/aws-sdk/apis/databrew-2017-07-25.min.json +41 -38
- package/node_modules/aws-sdk/apis/dataexchange-2017-07-25.min.json +83 -4
- package/node_modules/aws-sdk/apis/datasync-2018-11-09.min.json +144 -74
- package/node_modules/aws-sdk/apis/devops-guru-2020-12-01.min.json +213 -119
- package/node_modules/aws-sdk/apis/discovery-2015-11-01.min.json +67 -32
- package/node_modules/aws-sdk/apis/docdb-2014-10-31.min.json +10 -2
- package/node_modules/aws-sdk/apis/dynamodb-2012-08-10.min.json +10 -4
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.min.json +1179 -850
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.waiters2.json +18 -0
- package/node_modules/aws-sdk/apis/ecr-2015-09-21.min.json +14 -11
- package/node_modules/aws-sdk/apis/ecr-2015-09-21.paginators.json +4 -1
- package/node_modules/aws-sdk/apis/ecs-2014-11-13.min.json +10 -0
- package/node_modules/aws-sdk/apis/elasticfilesystem-2015-02-01.min.json +149 -21
- package/node_modules/aws-sdk/apis/elasticmapreduce-2009-03-31.min.json +47 -35
- package/node_modules/aws-sdk/apis/es-2015-01-01.min.json +125 -49
- package/node_modules/aws-sdk/apis/eventbridge-2015-10-07.min.json +262 -19
- package/node_modules/aws-sdk/apis/evidently-2021-02-01.min.json +14 -0
- package/node_modules/aws-sdk/apis/finspace-data-2020-07-13.min.json +454 -7
- package/node_modules/aws-sdk/apis/finspace-data-2020-07-13.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/fis-2020-12-01.min.json +229 -31
- package/node_modules/aws-sdk/apis/fis-2020-12-01.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/fms-2018-01-01.min.json +265 -82
- package/node_modules/aws-sdk/apis/fms-2018-01-01.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/frauddetector-2019-11-15.min.json +212 -6
- package/node_modules/aws-sdk/apis/frauddetector-2019-11-15.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/fsx-2018-03-01.min.json +123 -98
- package/node_modules/aws-sdk/apis/fsx-2018-03-01.paginators.json +4 -2
- package/node_modules/aws-sdk/apis/gamesparks-2021-08-17.examples.json +5 -0
- package/node_modules/aws-sdk/apis/gamesparks-2021-08-17.min.json +1363 -0
- package/node_modules/aws-sdk/apis/gamesparks-2021-08-17.paginators.json +46 -0
- package/node_modules/aws-sdk/apis/glue-2017-03-31.min.json +2257 -440
- package/node_modules/aws-sdk/apis/glue-2017-03-31.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/grafana-2020-08-18.min.json +194 -19
- package/node_modules/aws-sdk/apis/guardduty-2017-11-28.min.json +352 -77
- package/node_modules/aws-sdk/apis/imagebuilder-2019-12-02.min.json +107 -73
- package/node_modules/aws-sdk/apis/iot-2015-05-28.min.json +280 -202
- package/node_modules/aws-sdk/apis/iot-2015-05-28.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/iot-data-2015-05-28.min.json +1 -1
- package/node_modules/aws-sdk/apis/iotsecuretunneling-2018-10-05.min.json +28 -0
- package/node_modules/aws-sdk/apis/iotsitewise-2019-12-02.min.json +516 -168
- package/node_modules/aws-sdk/apis/iotsitewise-2019-12-02.paginators.json +14 -0
- package/node_modules/aws-sdk/apis/iottwinmaker-2021-11-29.min.json +75 -68
- package/node_modules/aws-sdk/apis/iotwireless-2020-11-22.min.json +401 -80
- package/node_modules/aws-sdk/apis/iotwireless-2020-11-22.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/ivschat-2020-07-14.examples.json +5 -0
- package/node_modules/aws-sdk/apis/ivschat-2020-07-14.min.json +443 -0
- package/node_modules/aws-sdk/apis/ivschat-2020-07-14.paginators.json +9 -0
- package/node_modules/aws-sdk/apis/kafka-2018-11-14.min.json +114 -94
- package/node_modules/aws-sdk/apis/kafkaconnect-2021-09-14.min.json +95 -48
- package/node_modules/aws-sdk/apis/kendra-2019-02-03.min.json +349 -83
- package/node_modules/aws-sdk/apis/kendra-2019-02-03.paginators.json +20 -0
- package/node_modules/aws-sdk/apis/keyspaces-2022-02-10.examples.json +5 -0
- package/node_modules/aws-sdk/apis/keyspaces-2022-02-10.min.json +562 -0
- package/node_modules/aws-sdk/apis/keyspaces-2022-02-10.paginators.json +22 -0
- package/node_modules/aws-sdk/apis/keyspaces-2022-02-10.waiters2.json +5 -0
- package/node_modules/aws-sdk/apis/kinesis-video-archived-media-2017-09-30.min.json +64 -0
- package/node_modules/aws-sdk/apis/kinesis-video-archived-media-2017-09-30.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/kinesisvideo-2017-09-30.min.json +145 -8
- package/node_modules/aws-sdk/apis/kms-2014-11-01.examples.json +239 -9
- package/node_modules/aws-sdk/apis/kms-2014-11-01.min.json +80 -12
- package/node_modules/aws-sdk/apis/lakeformation-2017-03-31.min.json +0 -1
- package/node_modules/aws-sdk/apis/lambda-2015-03-31.min.json +418 -149
- package/node_modules/aws-sdk/apis/lambda-2015-03-31.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/lambda-2015-03-31.waiters2.json +54 -2
- package/node_modules/aws-sdk/apis/lightsail-2016-11-28.min.json +117 -56
- package/node_modules/aws-sdk/apis/location-2020-11-19.min.json +20 -12
- package/node_modules/aws-sdk/apis/location-2020-11-19.paginators.json +2 -0
- package/node_modules/aws-sdk/apis/lookoutequipment-2020-12-15.min.json +274 -12
- package/node_modules/aws-sdk/apis/lookoutequipment-2020-12-15.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/lookoutmetrics-2017-07-25.min.json +123 -0
- package/node_modules/aws-sdk/apis/lookoutvision-2020-11-20.min.json +0 -1
- package/node_modules/aws-sdk/apis/macie2-2020-01-01.min.json +31 -28
- package/node_modules/aws-sdk/apis/mediaconnect-2018-11-14.min.json +83 -27
- package/node_modules/aws-sdk/apis/mediaconvert-2017-08-29.min.json +179 -127
- package/node_modules/aws-sdk/apis/medialive-2017-10-14.min.json +222 -154
- package/node_modules/aws-sdk/apis/mediapackage-vod-2018-11-07.min.json +16 -13
- package/node_modules/aws-sdk/apis/mediatailor-2018-04-23.min.json +416 -139
- package/node_modules/aws-sdk/apis/mediatailor-2018-04-23.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/metadata.json +20 -0
- package/node_modules/aws-sdk/apis/meteringmarketplace-2016-01-14.min.json +2 -1
- package/node_modules/aws-sdk/apis/mgn-2020-02-26.min.json +15 -19
- package/node_modules/aws-sdk/apis/models.lex.v2-2020-08-07.min.json +0 -2
- package/node_modules/aws-sdk/apis/monitoring-2010-08-01.min.json +47 -11
- package/node_modules/aws-sdk/apis/mq-2017-11-27.min.json +22 -7
- package/node_modules/aws-sdk/apis/network-firewall-2020-11-12.min.json +139 -53
- package/node_modules/aws-sdk/apis/opensearch-2021-01-01.min.json +125 -49
- package/node_modules/aws-sdk/apis/organizations-2016-11-28.min.json +77 -62
- package/node_modules/aws-sdk/apis/outposts-2019-12-03.min.json +74 -0
- package/node_modules/aws-sdk/apis/outposts-2019-12-03.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/panorama-2019-07-24.min.json +414 -346
- package/node_modules/aws-sdk/apis/personalize-2018-05-22.min.json +189 -42
- package/node_modules/aws-sdk/apis/pinpoint-2016-12-01.min.json +2 -1
- package/node_modules/aws-sdk/apis/pinpoint-sms-voice-v2-2022-03-31.examples.json +5 -0
- package/node_modules/aws-sdk/apis/pinpoint-sms-voice-v2-2022-03-31.min.json +1681 -0
- package/node_modules/aws-sdk/apis/pinpoint-sms-voice-v2-2022-03-31.paginators.json +70 -0
- package/node_modules/aws-sdk/apis/pinpoint-sms-voice-v2-2022-03-31.waiters2.json +5 -0
- package/node_modules/aws-sdk/apis/proton-2020-07-20.min.json +4 -1
- package/node_modules/aws-sdk/apis/quicksight-2018-04-01.min.json +151 -43
- package/node_modules/aws-sdk/apis/rds-2014-10-31.min.json +289 -413
- package/node_modules/aws-sdk/apis/rds-2014-10-31.paginators.json +0 -12
- package/node_modules/aws-sdk/apis/rds-data-2018-08-01.min.json +4 -1
- package/node_modules/aws-sdk/apis/redshift-2012-12-01.min.json +41 -23
- package/node_modules/aws-sdk/apis/rekognition-2016-06-27.min.json +247 -111
- package/node_modules/aws-sdk/apis/resiliencehub-2020-04-30.min.json +125 -74
- package/node_modules/aws-sdk/apis/robomaker-2018-06-29.min.json +148 -48
- package/node_modules/aws-sdk/apis/route53-recovery-cluster-2019-12-02.min.json +49 -3
- package/node_modules/aws-sdk/apis/route53-recovery-cluster-2019-12-02.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/s3-2006-03-01.examples.json +97 -97
- package/node_modules/aws-sdk/apis/s3-2006-03-01.min.json +772 -239
- package/node_modules/aws-sdk/apis/s3control-2018-08-20.min.json +154 -53
- package/node_modules/aws-sdk/apis/s3outposts-2017-07-25.min.json +64 -24
- package/node_modules/aws-sdk/apis/s3outposts-2017-07-25.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/sagemaker-2017-07-24.min.json +732 -691
- package/node_modules/aws-sdk/apis/secretsmanager-2017-10-17.examples.json +15 -13
- package/node_modules/aws-sdk/apis/secretsmanager-2017-10-17.min.json +15 -10
- package/node_modules/aws-sdk/apis/securityhub-2018-10-26.min.json +392 -304
- package/node_modules/aws-sdk/apis/servicecatalog-2015-12-10.min.json +16 -8
- package/node_modules/aws-sdk/apis/servicecatalog-appregistry-2020-06-24.min.json +8 -2
- package/node_modules/aws-sdk/apis/ssm-2014-11-06.min.json +333 -294
- package/node_modules/aws-sdk/apis/ssm-contacts-2021-05-03.examples.json +1 -1
- package/node_modules/aws-sdk/apis/ssm-incidents-2018-05-10.min.json +48 -37
- package/node_modules/aws-sdk/apis/synthetics-2017-10-11.min.json +49 -36
- package/node_modules/aws-sdk/apis/textract-2018-06-27.min.json +82 -45
- package/node_modules/aws-sdk/apis/transcribe-2017-10-26.min.json +50 -40
- package/node_modules/aws-sdk/apis/transfer-2018-11-05.min.json +57 -47
- package/node_modules/aws-sdk/apis/transfer-2018-11-05.paginators.json +27 -8
- package/node_modules/aws-sdk/apis/transfer-2018-11-05.waiters2.json +45 -0
- package/node_modules/aws-sdk/apis/translate-2017-07-01.min.json +19 -18
- package/node_modules/aws-sdk/apis/wafv2-2019-07-29.min.json +313 -131
- package/node_modules/aws-sdk/apis/wisdom-2020-10-19.min.json +60 -19
- package/node_modules/aws-sdk/apis/worklink-2018-09-25.min.json +99 -33
- package/node_modules/aws-sdk/apis/workspaces-2015-04-08.min.json +195 -27
- package/node_modules/aws-sdk/apis/workspaces-web-2020-07-08.min.json +107 -36
- package/node_modules/aws-sdk/clients/acmpca.d.ts +72 -36
- package/node_modules/aws-sdk/clients/all.d.ts +6 -0
- package/node_modules/aws-sdk/clients/all.js +7 -1
- package/node_modules/aws-sdk/clients/amplify.d.ts +19 -14
- package/node_modules/aws-sdk/clients/amplifybackend.d.ts +48 -12
- package/node_modules/aws-sdk/clients/amplifyuibuilder.d.ts +142 -18
- package/node_modules/aws-sdk/clients/appconfig.d.ts +13 -13
- package/node_modules/aws-sdk/clients/appconfigdata.d.ts +18 -18
- package/node_modules/aws-sdk/clients/appflow.d.ts +691 -4
- package/node_modules/aws-sdk/clients/apprunner.d.ts +371 -20
- package/node_modules/aws-sdk/clients/appstream.d.ts +13 -1
- package/node_modules/aws-sdk/clients/athena.d.ts +92 -8
- package/node_modules/aws-sdk/clients/auditmanager.d.ts +10 -10
- package/node_modules/aws-sdk/clients/autoscaling.d.ts +62 -34
- package/node_modules/aws-sdk/clients/backup.d.ts +49 -25
- package/node_modules/aws-sdk/clients/batch.d.ts +116 -48
- package/node_modules/aws-sdk/clients/billingconductor.d.ts +1554 -0
- package/node_modules/aws-sdk/clients/billingconductor.js +19 -0
- package/node_modules/aws-sdk/clients/braket.d.ts +7 -2
- package/node_modules/aws-sdk/clients/budgets.d.ts +107 -48
- package/node_modules/aws-sdk/clients/chime.d.ts +10 -6
- package/node_modules/aws-sdk/clients/chimesdkmediapipelines.d.ts +348 -0
- package/node_modules/aws-sdk/clients/chimesdkmediapipelines.js +18 -0
- package/node_modules/aws-sdk/clients/chimesdkmeetings.d.ts +31 -5
- package/node_modules/aws-sdk/clients/cloudcontrol.d.ts +24 -24
- package/node_modules/aws-sdk/clients/cloudformation.d.ts +408 -265
- package/node_modules/aws-sdk/clients/cloudfront.d.ts +15 -0
- package/node_modules/aws-sdk/clients/cloudtrail.d.ts +34 -26
- package/node_modules/aws-sdk/clients/cloudwatch.d.ts +44 -12
- package/node_modules/aws-sdk/clients/codegurureviewer.d.ts +24 -10
- package/node_modules/aws-sdk/clients/cognitoidentityserviceprovider.d.ts +299 -294
- package/node_modules/aws-sdk/clients/comprehend.d.ts +337 -5
- package/node_modules/aws-sdk/clients/computeoptimizer.d.ts +3 -3
- package/node_modules/aws-sdk/clients/configservice.d.ts +220 -49
- package/node_modules/aws-sdk/clients/connect.d.ts +877 -30
- package/node_modules/aws-sdk/clients/costexplorer.d.ts +105 -19
- package/node_modules/aws-sdk/clients/customerprofiles.d.ts +365 -2
- package/node_modules/aws-sdk/clients/databrew.d.ts +8 -3
- package/node_modules/aws-sdk/clients/dataexchange.d.ts +117 -0
- package/node_modules/aws-sdk/clients/datasync.d.ts +103 -16
- package/node_modules/aws-sdk/clients/devopsguru.d.ts +109 -3
- package/node_modules/aws-sdk/clients/discovery.d.ts +63 -26
- package/node_modules/aws-sdk/clients/docdb.d.ts +56 -40
- package/node_modules/aws-sdk/clients/dynamodb.d.ts +15 -7
- package/node_modules/aws-sdk/clients/ebs.d.ts +13 -13
- package/node_modules/aws-sdk/clients/ec2.d.ts +571 -145
- package/node_modules/aws-sdk/clients/ecr.d.ts +10 -5
- package/node_modules/aws-sdk/clients/ecs.d.ts +51 -35
- package/node_modules/aws-sdk/clients/efs.d.ts +153 -26
- package/node_modules/aws-sdk/clients/eks.d.ts +14 -14
- package/node_modules/aws-sdk/clients/elasticache.d.ts +13 -13
- package/node_modules/aws-sdk/clients/emr.d.ts +38 -14
- package/node_modules/aws-sdk/clients/es.d.ts +97 -0
- package/node_modules/aws-sdk/clients/eventbridge.d.ts +386 -13
- package/node_modules/aws-sdk/clients/eventbridge.js +1 -0
- package/node_modules/aws-sdk/clients/evidently.d.ts +19 -7
- package/node_modules/aws-sdk/clients/finspacedata.d.ts +520 -46
- package/node_modules/aws-sdk/clients/fis.d.ts +266 -22
- package/node_modules/aws-sdk/clients/fms.d.ts +333 -3
- package/node_modules/aws-sdk/clients/frauddetector.d.ts +308 -0
- package/node_modules/aws-sdk/clients/fsx.d.ts +105 -69
- package/node_modules/aws-sdk/clients/gamelift.d.ts +186 -186
- package/node_modules/aws-sdk/clients/gamesparks.d.ts +1324 -0
- package/node_modules/aws-sdk/clients/gamesparks.js +18 -0
- package/node_modules/aws-sdk/clients/glue.d.ts +2588 -188
- package/node_modules/aws-sdk/clients/grafana.d.ts +153 -6
- package/node_modules/aws-sdk/clients/greengrassv2.d.ts +6 -6
- package/node_modules/aws-sdk/clients/guardduty.d.ts +314 -46
- package/node_modules/aws-sdk/clients/iam.d.ts +10 -10
- package/node_modules/aws-sdk/clients/imagebuilder.d.ts +55 -6
- package/node_modules/aws-sdk/clients/iot.d.ts +88 -22
- package/node_modules/aws-sdk/clients/iotdata.d.ts +7 -7
- package/node_modules/aws-sdk/clients/iotsecuretunneling.d.ts +52 -18
- package/node_modules/aws-sdk/clients/iotsitewise.d.ts +369 -0
- package/node_modules/aws-sdk/clients/iottwinmaker.d.ts +25 -8
- package/node_modules/aws-sdk/clients/iotwireless.d.ts +356 -25
- package/node_modules/aws-sdk/clients/ivschat.d.ts +523 -0
- package/node_modules/aws-sdk/clients/ivschat.js +18 -0
- package/node_modules/aws-sdk/clients/kafka.d.ts +19 -1
- package/node_modules/aws-sdk/clients/kafkaconnect.d.ts +50 -5
- package/node_modules/aws-sdk/clients/kendra.d.ts +489 -138
- package/node_modules/aws-sdk/clients/keyspaces.d.ts +652 -0
- package/node_modules/aws-sdk/clients/keyspaces.js +19 -0
- package/node_modules/aws-sdk/clients/kinesisvideo.d.ts +177 -10
- package/node_modules/aws-sdk/clients/kinesisvideoarchivedmedia.d.ts +94 -0
- package/node_modules/aws-sdk/clients/kms.d.ts +209 -119
- package/node_modules/aws-sdk/clients/lakeformation.d.ts +2 -2
- package/node_modules/aws-sdk/clients/lambda.d.ts +319 -16
- package/node_modules/aws-sdk/clients/lexmodelsv2.d.ts +2 -2
- package/node_modules/aws-sdk/clients/lightsail.d.ts +175 -64
- package/node_modules/aws-sdk/clients/location.d.ts +28 -19
- package/node_modules/aws-sdk/clients/lookoutequipment.d.ts +295 -9
- package/node_modules/aws-sdk/clients/lookoutmetrics.d.ts +160 -0
- package/node_modules/aws-sdk/clients/lookoutvision.d.ts +4 -4
- package/node_modules/aws-sdk/clients/macie.d.ts +50 -50
- package/node_modules/aws-sdk/clients/macie2.d.ts +7 -2
- package/node_modules/aws-sdk/clients/marketplacemetering.d.ts +17 -12
- package/node_modules/aws-sdk/clients/mediaconnect.d.ts +47 -0
- package/node_modules/aws-sdk/clients/mediaconvert.d.ts +98 -18
- package/node_modules/aws-sdk/clients/medialive.d.ts +79 -3
- package/node_modules/aws-sdk/clients/mediapackage.d.ts +4 -4
- package/node_modules/aws-sdk/clients/mediapackagevod.d.ts +5 -0
- package/node_modules/aws-sdk/clients/mediatailor.d.ts +327 -12
- package/node_modules/aws-sdk/clients/mgn.d.ts +63 -50
- package/node_modules/aws-sdk/clients/migrationhubrefactorspaces.d.ts +17 -17
- package/node_modules/aws-sdk/clients/mq.d.ts +16 -1
- package/node_modules/aws-sdk/clients/networkfirewall.d.ts +151 -21
- package/node_modules/aws-sdk/clients/opensearch.d.ts +97 -0
- package/node_modules/aws-sdk/clients/organizations.d.ts +146 -131
- package/node_modules/aws-sdk/clients/outposts.d.ts +94 -22
- package/node_modules/aws-sdk/clients/panorama.d.ts +467 -406
- package/node_modules/aws-sdk/clients/personalize.d.ts +191 -25
- package/node_modules/aws-sdk/clients/pi.d.ts +26 -26
- package/node_modules/aws-sdk/clients/pinpoint.d.ts +4 -0
- package/node_modules/aws-sdk/clients/pinpointsmsvoicev2.d.ts +2367 -0
- package/node_modules/aws-sdk/clients/pinpointsmsvoicev2.js +19 -0
- package/node_modules/aws-sdk/clients/polly.d.ts +3 -3
- package/node_modules/aws-sdk/clients/pricing.d.ts +3 -3
- package/node_modules/aws-sdk/clients/proton.d.ts +105 -101
- package/node_modules/aws-sdk/clients/quicksight.d.ts +114 -12
- package/node_modules/aws-sdk/clients/ram.d.ts +5 -5
- package/node_modules/aws-sdk/clients/rbin.d.ts +41 -41
- package/node_modules/aws-sdk/clients/rds.d.ts +600 -779
- package/node_modules/aws-sdk/clients/rdsdataservice.d.ts +22 -7
- package/node_modules/aws-sdk/clients/redshift.d.ts +68 -30
- package/node_modules/aws-sdk/clients/rekognition.d.ts +209 -53
- package/node_modules/aws-sdk/clients/resiliencehub.d.ts +138 -58
- package/node_modules/aws-sdk/clients/robomaker.d.ts +37 -36
- package/node_modules/aws-sdk/clients/route53.d.ts +12 -12
- package/node_modules/aws-sdk/clients/route53recoverycluster.d.ts +82 -10
- package/node_modules/aws-sdk/clients/route53recoveryreadiness.d.ts +275 -230
- package/node_modules/aws-sdk/clients/s3.d.ts +735 -204
- package/node_modules/aws-sdk/clients/s3control.d.ts +145 -13
- package/node_modules/aws-sdk/clients/s3outposts.d.ts +50 -18
- package/node_modules/aws-sdk/clients/sagemaker.d.ts +252 -182
- package/node_modules/aws-sdk/clients/secretsmanager.d.ts +77 -63
- package/node_modules/aws-sdk/clients/securityhub.d.ts +166 -7
- package/node_modules/aws-sdk/clients/servicecatalog.d.ts +8 -4
- package/node_modules/aws-sdk/clients/sns.d.ts +2 -2
- package/node_modules/aws-sdk/clients/ssm.d.ts +90 -37
- package/node_modules/aws-sdk/clients/ssmcontacts.d.ts +2 -2
- package/node_modules/aws-sdk/clients/ssmincidents.d.ts +21 -7
- package/node_modules/aws-sdk/clients/storagegateway.d.ts +24 -24
- package/node_modules/aws-sdk/clients/sts.d.ts +5 -5
- package/node_modules/aws-sdk/clients/synthetics.d.ts +25 -10
- package/node_modules/aws-sdk/clients/textract.d.ts +47 -14
- package/node_modules/aws-sdk/clients/timestreamquery.d.ts +1 -1
- package/node_modules/aws-sdk/clients/transcribeservice.d.ts +119 -103
- package/node_modules/aws-sdk/clients/transfer.d.ts +77 -14
- package/node_modules/aws-sdk/clients/transfer.js +1 -0
- package/node_modules/aws-sdk/clients/translate.d.ts +2 -0
- package/node_modules/aws-sdk/clients/wafv2.d.ts +274 -34
- package/node_modules/aws-sdk/clients/wisdom.d.ts +77 -32
- package/node_modules/aws-sdk/clients/workspaces.d.ts +243 -4
- package/node_modules/aws-sdk/clients/workspacesweb.d.ts +38 -4
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +44 -32
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +1367 -1072
- package/node_modules/aws-sdk/dist/aws-sdk.js +6655 -3278
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +94 -92
- package/node_modules/aws-sdk/lib/config-base.d.ts +1 -0
- package/node_modules/aws-sdk/lib/config_service_placeholders.d.ts +12 -0
- package/node_modules/aws-sdk/lib/core.d.ts +1 -0
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/lib/credentials/credential_provider_chain.js +1 -0
- package/node_modules/aws-sdk/lib/credentials/ec2_metadata_credentials.d.ts +28 -18
- package/node_modules/aws-sdk/lib/credentials/ec2_metadata_credentials.js +75 -18
- package/node_modules/aws-sdk/lib/credentials/sso_credentials.d.ts +14 -0
- package/node_modules/aws-sdk/lib/credentials/sso_credentials.js +179 -0
- package/node_modules/aws-sdk/lib/dynamodb/document_client.d.ts +9 -1
- package/node_modules/aws-sdk/lib/model/operation.js +6 -1
- package/node_modules/aws-sdk/lib/node_loader.js +2 -0
- package/node_modules/aws-sdk/lib/param_validator.js +2 -1
- package/node_modules/aws-sdk/lib/region_config_data.json +10 -0
- package/node_modules/aws-sdk/lib/services/eventbridge.js +19 -0
- package/node_modules/aws-sdk/lib/services/s3.js +2 -1
- package/node_modules/aws-sdk/lib/services/s3util.js +6 -1
- package/node_modules/aws-sdk/package.json +2 -2
- package/node_modules/aws-sdk/scripts/region-checker/allowlist.js +8 -5
- package/node_modules/jmespath/jmespath.js +32 -27
- package/node_modules/jmespath/package.json +2 -7
- package/node_modules/jszip/.github/workflows/pr.yaml +42 -0
- package/node_modules/jszip/CHANGES.md +15 -1
- package/node_modules/jszip/LICENSE.markdown +1 -1
- package/node_modules/jszip/dist/jszip.js +37 -5
- package/node_modules/jszip/dist/jszip.min.js +2 -2
- package/node_modules/jszip/index.d.ts +79 -14
- package/node_modules/jszip/lib/index.js +1 -1
- package/node_modules/jszip/lib/load.js +8 -1
- package/node_modules/jszip/lib/utils.js +27 -2
- package/node_modules/jszip/package.json +9 -8
- package/node_modules/jszip/tsconfig.json +101 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/.npmignore +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/CHANGELOG.md +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/LICENSE +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/README.md +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/Utility.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLAttribute.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLCData.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLComment.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLDTDAttList.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLDTDElement.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLDTDEntity.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLDTDNotation.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLDeclaration.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLDocType.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLDocument.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLDocumentCB.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLElement.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLNode.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLProcessingInstruction.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLRaw.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLStreamWriter.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLStringWriter.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLStringifier.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLText.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/XMLWriterBase.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/lib/index.js +0 -0
- package/node_modules/{xmlbuilder → xml2js/node_modules/xmlbuilder}/package.json +0 -0
- package/package.json +20 -15
- package/releasetag.txt +1 -1
- package/version.txt +1 -1
- package/node_modules/jmespath/.eslintrc +0 -10
- package/node_modules/jmespath/.npmignore +0 -1
- package/node_modules/jmespath/.travis.yml +0 -6
- package/node_modules/jmespath/BASELINE +0 -15
- package/node_modules/jmespath/Gruntfile.js +0 -36
- package/node_modules/jmespath/g.sh +0 -5
- package/node_modules/jmespath/index.html +0 -93
- package/node_modules/jmespath/james.html +0 -7
- package/node_modules/jmespath/l.js +0 -189
- package/node_modules/jmespath/perf.js +0 -33
- package/node_modules/jmespath/reservedWords.json +0 -4
- package/node_modules/jmespath/test/compliance/basic.json +0 -96
- package/node_modules/jmespath/test/compliance/boolean.json +0 -257
- package/node_modules/jmespath/test/compliance/current.json +0 -25
- package/node_modules/jmespath/test/compliance/escape.json +0 -46
- package/node_modules/jmespath/test/compliance/filters.json +0 -468
- package/node_modules/jmespath/test/compliance/functions.json +0 -825
- package/node_modules/jmespath/test/compliance/identifiers.json +0 -1377
- package/node_modules/jmespath/test/compliance/indices.json +0 -346
- package/node_modules/jmespath/test/compliance/literal.json +0 -190
- package/node_modules/jmespath/test/compliance/multiselect.json +0 -393
- package/node_modules/jmespath/test/compliance/pipe.json +0 -131
- package/node_modules/jmespath/test/compliance/slice.json +0 -187
- package/node_modules/jmespath/test/compliance/syntax.json +0 -616
- package/node_modules/jmespath/test/compliance/unicode.json +0 -38
- package/node_modules/jmespath/test/compliance/wildcard.json +0 -460
- package/node_modules/jmespath/test/compliance.js +0 -56
- package/node_modules/jmespath/test/jmespath.js +0 -217
|
@@ -34,11 +34,11 @@ declare class S3 extends S3Customizations {
|
|
|
34
34
|
*/
|
|
35
35
|
completeMultipartUpload(callback?: (err: AWSError, data: S3.Types.CompleteMultipartUploadOutput) => void): Request<S3.Types.CompleteMultipartUploadOutput, AWSError>;
|
|
36
36
|
/**
|
|
37
|
-
* Creates a copy of an object that is already stored in Amazon S3. You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For more information, see Copy Object Using the REST Multipart Upload API. All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account. A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy action starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the 200 OK response. This means that a 200 OK response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately. If the copy is successful, you receive a response with information about the copied object. If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body. The copy request charge is based on the storage class and Region that you specify for the destination object. For pricing information, see Amazon S3 pricing. Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad Request error. For more information, see Transfer Acceleration. Metadata When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs. To specify whether you want the object metadata copied from the source object or replaced with metadata provided in the request, you can optionally add the x-amz-metadata-directive header. When you grant permissions, you can use the s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when objects are uploaded. For more information, see Specifying Conditions in a Policy in the Amazon S3 User Guide. For a complete list of Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for Amazon S3.
|
|
37
|
+
* Creates a copy of an object that is already stored in Amazon S3. You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy (UploadPartCopy) API. For more information, see Copy Object Using the REST Multipart Upload API. All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account. A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy action starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the 200 OK response. This means that a 200 OK response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately. If the copy is successful, you receive a response with information about the copied object. If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body. The copy request charge is based on the storage class and Region that you specify for the destination object. For pricing information, see Amazon S3 pricing. Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad Request error. For more information, see Transfer Acceleration. Metadata When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs. To specify whether you want the object metadata copied from the source object or replaced with metadata provided in the request, you can optionally add the x-amz-metadata-directive header. When you grant permissions, you can use the s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when objects are uploaded. For more information, see Specifying Conditions in a Policy in the Amazon S3 User Guide. For a complete list of Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for Amazon S3. x-amz-copy-source-if Headers To only copy an object under certain conditions, such as whether the Etag matches or whether the object was modified before or after a specified date, use the following request parameters: x-amz-copy-source-if-match x-amz-copy-source-if-none-match x-amz-copy-source-if-unmodified-since x-amz-copy-source-if-modified-since If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies the data: x-amz-copy-source-if-match condition evaluates to true x-amz-copy-source-if-unmodified-since condition evaluates to false If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request and evaluate as follows, Amazon S3 returns the 412 Precondition Failed response code: x-amz-copy-source-if-none-match condition evaluates to false x-amz-copy-source-if-modified-since condition evaluates to true All headers with the x-amz- prefix, including x-amz-copy-source, must be signed. Server-side encryption When you perform a CopyObject operation, you can optionally use the appropriate encryption-related headers to encrypt the object using server-side encryption with Amazon Web Services managed encryption keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. For more information about server-side encryption, see Using Server-Side Encryption. If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide. Access Control List (ACL)-Specific Request Headers When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API. If the bucket that you're copying objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format. For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide. If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner. Checksums When copying an object, if it has a checksum, that checksum will be copied to the new object by default. When you copy the object over, you may optionally specify a different checksum algorithm to use with the x-amz-checksum-algorithm header. Storage Class Options You can use the CopyObject action to change the storage class of an object that is already stored in Amazon S3 using the StorageClass parameter. For more information, see Storage Classes in the Amazon S3 User Guide. Versioning By default, x-amz-copy-source identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use the versionId subresource. If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id response header in the response. If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null. If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see RestoreObject. The following operations are related to CopyObject: PutObject GetObject For more information, see Copying Objects.
|
|
38
38
|
*/
|
|
39
39
|
copyObject(params: S3.Types.CopyObjectRequest, callback?: (err: AWSError, data: S3.Types.CopyObjectOutput) => void): Request<S3.Types.CopyObjectOutput, AWSError>;
|
|
40
40
|
/**
|
|
41
|
-
* Creates a copy of an object that is already stored in Amazon S3. You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For more information, see Copy Object Using the REST Multipart Upload API. All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account. A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy action starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the 200 OK response. This means that a 200 OK response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately. If the copy is successful, you receive a response with information about the copied object. If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body. The copy request charge is based on the storage class and Region that you specify for the destination object. For pricing information, see Amazon S3 pricing. Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad Request error. For more information, see Transfer Acceleration. Metadata When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs. To specify whether you want the object metadata copied from the source object or replaced with metadata provided in the request, you can optionally add the x-amz-metadata-directive header. When you grant permissions, you can use the s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when objects are uploaded. For more information, see Specifying Conditions in a Policy in the Amazon S3 User Guide. For a complete list of Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for Amazon S3.
|
|
41
|
+
* Creates a copy of an object that is already stored in Amazon S3. You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy (UploadPartCopy) API. For more information, see Copy Object Using the REST Multipart Upload API. All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account. A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy action starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the 200 OK response. This means that a 200 OK response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately. If the copy is successful, you receive a response with information about the copied object. If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body. The copy request charge is based on the storage class and Region that you specify for the destination object. For pricing information, see Amazon S3 pricing. Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad Request error. For more information, see Transfer Acceleration. Metadata When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs. To specify whether you want the object metadata copied from the source object or replaced with metadata provided in the request, you can optionally add the x-amz-metadata-directive header. When you grant permissions, you can use the s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when objects are uploaded. For more information, see Specifying Conditions in a Policy in the Amazon S3 User Guide. For a complete list of Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for Amazon S3. x-amz-copy-source-if Headers To only copy an object under certain conditions, such as whether the Etag matches or whether the object was modified before or after a specified date, use the following request parameters: x-amz-copy-source-if-match x-amz-copy-source-if-none-match x-amz-copy-source-if-unmodified-since x-amz-copy-source-if-modified-since If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies the data: x-amz-copy-source-if-match condition evaluates to true x-amz-copy-source-if-unmodified-since condition evaluates to false If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request and evaluate as follows, Amazon S3 returns the 412 Precondition Failed response code: x-amz-copy-source-if-none-match condition evaluates to false x-amz-copy-source-if-modified-since condition evaluates to true All headers with the x-amz- prefix, including x-amz-copy-source, must be signed. Server-side encryption When you perform a CopyObject operation, you can optionally use the appropriate encryption-related headers to encrypt the object using server-side encryption with Amazon Web Services managed encryption keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. For more information about server-side encryption, see Using Server-Side Encryption. If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide. Access Control List (ACL)-Specific Request Headers When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API. If the bucket that you're copying objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format. For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide. If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner. Checksums When copying an object, if it has a checksum, that checksum will be copied to the new object by default. When you copy the object over, you may optionally specify a different checksum algorithm to use with the x-amz-checksum-algorithm header. Storage Class Options You can use the CopyObject action to change the storage class of an object that is already stored in Amazon S3 using the StorageClass parameter. For more information, see Storage Classes in the Amazon S3 User Guide. Versioning By default, x-amz-copy-source identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use the versionId subresource. If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id response header in the response. If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null. If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see RestoreObject. The following operations are related to CopyObject: PutObject GetObject For more information, see Copying Objects.
|
|
42
42
|
*/
|
|
43
43
|
copyObject(callback?: (err: AWSError, data: S3.Types.CopyObjectOutput) => void): Request<S3.Types.CopyObjectOutput, AWSError>;
|
|
44
44
|
/**
|
|
@@ -50,11 +50,11 @@ declare class S3 extends S3Customizations {
|
|
|
50
50
|
*/
|
|
51
51
|
createBucket(callback?: (err: AWSError, data: S3.Types.CreateBucketOutput) => void): Request<S3.Types.CreateBucketOutput, AWSError>;
|
|
52
52
|
/**
|
|
53
|
-
* This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request. For more information about multipart uploads, see Multipart Upload Overview. If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. For information about the permissions required to use the multipart upload API, see Multipart Upload and Permissions. For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (Amazon Web Services Signature Version 4). After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload. You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use Amazon Web Services KMS keys or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must match the headers you used in the request to initiate the upload by using CreateMultipartUpload. To perform a multipart upload with encryption using an Amazon Web Services KMS key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey* actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see Multipart upload API and permissions in the Amazon S3 User Guide. If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role. For more information, see Protecting Data Using Server-Side Encryption. Access Permissions When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers: Specify a canned ACL with the x-amz-acl request header. For more information, see Canned ACL. Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. You can use either a canned ACL or specify access permissions explicitly. You cannot do both. Server-Side- Encryption-Specific Request Headers You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use Amazon Web Services managed encryption keys or provide your own encryption key. Use encryption keys managed by Amazon S3 or customer managed key stored in Amazon Web Services Key Management Service (Amazon Web Services KMS) – If you want Amazon Web Services to manage the keys used to encrypt data, specify the following headers in the request.
|
|
53
|
+
* This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request. For more information about multipart uploads, see Multipart Upload Overview. If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. For information about the permissions required to use the multipart upload API, see Multipart Upload and Permissions. For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (Amazon Web Services Signature Version 4). After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload. You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use Amazon Web Services KMS keys or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must match the headers you used in the request to initiate the upload by using CreateMultipartUpload. To perform a multipart upload with encryption using an Amazon Web Services KMS key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey* actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see Multipart upload API and permissions in the Amazon S3 User Guide. If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role. For more information, see Protecting Data Using Server-Side Encryption. Access Permissions When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers: Specify a canned ACL with the x-amz-acl request header. For more information, see Canned ACL. Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. You can use either a canned ACL or specify access permissions explicitly. You cannot do both. Server-Side- Encryption-Specific Request Headers You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use Amazon Web Services managed encryption keys or provide your own encryption key. Use encryption keys managed by Amazon S3 or customer managed key stored in Amazon Web Services Key Management Service (Amazon Web Services KMS) – If you want Amazon Web Services to manage the keys used to encrypt data, specify the following headers in the request. x-amz-server-side-encryption x-amz-server-side-encryption-aws-kms-key-id x-amz-server-side-encryption-context If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key in Amazon Web Services KMS to protect the data. All GET and PUT requests for an object protected by Amazon Web Services KMS fail if you don't make them with SSL or by using SigV4. For more information about server-side encryption with KMS key (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys. Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request. x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 For more information about server-side encryption with KMS keys (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys. Access-Control-List (ACL)-Specific Request Headers You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods: Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL. Specify access permissions explicitly — To explicitly grant access permissions to specific Amazon Web Services accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use: x-amz-grant-read x-amz-grant-write x-amz-grant-read-acp x-amz-grant-write-acp x-amz-grant-full-control You specify each grantee as a type=value pair, where the type is one of the following: id – if the value specified is the canonical user ID of an Amazon Web Services account uri – if you are granting permissions to a predefined group emailAddress – if the value specified is the email address of an Amazon Web Services account Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: US East (N. Virginia) US West (N. California) US West (Oregon) Asia Pacific (Singapore) Asia Pacific (Sydney) Asia Pacific (Tokyo) Europe (Ireland) South America (São Paulo) For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference. For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata: x-amz-grant-read: id="11112222333", id="444455556666" The following operations are related to CreateMultipartUpload: UploadPart CompleteMultipartUpload AbortMultipartUpload ListParts ListMultipartUploads
|
|
54
54
|
*/
|
|
55
55
|
createMultipartUpload(params: S3.Types.CreateMultipartUploadRequest, callback?: (err: AWSError, data: S3.Types.CreateMultipartUploadOutput) => void): Request<S3.Types.CreateMultipartUploadOutput, AWSError>;
|
|
56
56
|
/**
|
|
57
|
-
* This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request. For more information about multipart uploads, see Multipart Upload Overview. If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. For information about the permissions required to use the multipart upload API, see Multipart Upload and Permissions. For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (Amazon Web Services Signature Version 4). After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload. You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use Amazon Web Services KMS keys or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must match the headers you used in the request to initiate the upload by using CreateMultipartUpload. To perform a multipart upload with encryption using an Amazon Web Services KMS key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey* actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see Multipart upload API and permissions in the Amazon S3 User Guide. If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role. For more information, see Protecting Data Using Server-Side Encryption. Access Permissions When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers: Specify a canned ACL with the x-amz-acl request header. For more information, see Canned ACL. Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. You can use either a canned ACL or specify access permissions explicitly. You cannot do both. Server-Side- Encryption-Specific Request Headers You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use Amazon Web Services managed encryption keys or provide your own encryption key. Use encryption keys managed by Amazon S3 or customer managed key stored in Amazon Web Services Key Management Service (Amazon Web Services KMS) – If you want Amazon Web Services to manage the keys used to encrypt data, specify the following headers in the request.
|
|
57
|
+
* This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request. For more information about multipart uploads, see Multipart Upload Overview. If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. For information about the permissions required to use the multipart upload API, see Multipart Upload and Permissions. For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (Amazon Web Services Signature Version 4). After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload. You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use Amazon Web Services KMS keys or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must match the headers you used in the request to initiate the upload by using CreateMultipartUpload. To perform a multipart upload with encryption using an Amazon Web Services KMS key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey* actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see Multipart upload API and permissions in the Amazon S3 User Guide. If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role. For more information, see Protecting Data Using Server-Side Encryption. Access Permissions When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers: Specify a canned ACL with the x-amz-acl request header. For more information, see Canned ACL. Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. You can use either a canned ACL or specify access permissions explicitly. You cannot do both. Server-Side- Encryption-Specific Request Headers You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use Amazon Web Services managed encryption keys or provide your own encryption key. Use encryption keys managed by Amazon S3 or customer managed key stored in Amazon Web Services Key Management Service (Amazon Web Services KMS) – If you want Amazon Web Services to manage the keys used to encrypt data, specify the following headers in the request. x-amz-server-side-encryption x-amz-server-side-encryption-aws-kms-key-id x-amz-server-side-encryption-context If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key in Amazon Web Services KMS to protect the data. All GET and PUT requests for an object protected by Amazon Web Services KMS fail if you don't make them with SSL or by using SigV4. For more information about server-side encryption with KMS key (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys. Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request. x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 For more information about server-side encryption with KMS keys (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys. Access-Control-List (ACL)-Specific Request Headers You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods: Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL. Specify access permissions explicitly — To explicitly grant access permissions to specific Amazon Web Services accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use: x-amz-grant-read x-amz-grant-write x-amz-grant-read-acp x-amz-grant-write-acp x-amz-grant-full-control You specify each grantee as a type=value pair, where the type is one of the following: id – if the value specified is the canonical user ID of an Amazon Web Services account uri – if you are granting permissions to a predefined group emailAddress – if the value specified is the email address of an Amazon Web Services account Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: US East (N. Virginia) US West (N. California) US West (Oregon) Asia Pacific (Singapore) Asia Pacific (Sydney) Asia Pacific (Tokyo) Europe (Ireland) South America (São Paulo) For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference. For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata: x-amz-grant-read: id="11112222333", id="444455556666" The following operations are related to CreateMultipartUpload: UploadPart CompleteMultipartUpload AbortMultipartUpload ListParts ListMultipartUploads
|
|
58
58
|
*/
|
|
59
59
|
createMultipartUpload(callback?: (err: AWSError, data: S3.Types.CreateMultipartUploadOutput) => void): Request<S3.Types.CreateMultipartUploadOutput, AWSError>;
|
|
60
60
|
/**
|
|
@@ -218,11 +218,11 @@ declare class S3 extends S3Customizations {
|
|
|
218
218
|
*/
|
|
219
219
|
getBucketAnalyticsConfiguration(callback?: (err: AWSError, data: S3.Types.GetBucketAnalyticsConfigurationOutput) => void): Request<S3.Types.GetBucketAnalyticsConfigurationOutput, AWSError>;
|
|
220
220
|
/**
|
|
221
|
-
* Returns the
|
|
221
|
+
* Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the bucket. To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others. For more information about CORS, see Enabling Cross-Origin Resource Sharing. The following operations are related to GetBucketCors: PutBucketCors DeleteBucketCors
|
|
222
222
|
*/
|
|
223
223
|
getBucketCors(params: S3.Types.GetBucketCorsRequest, callback?: (err: AWSError, data: S3.Types.GetBucketCorsOutput) => void): Request<S3.Types.GetBucketCorsOutput, AWSError>;
|
|
224
224
|
/**
|
|
225
|
-
* Returns the
|
|
225
|
+
* Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the bucket. To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others. For more information about CORS, see Enabling Cross-Origin Resource Sharing. The following operations are related to GetBucketCors: PutBucketCors DeleteBucketCors
|
|
226
226
|
*/
|
|
227
227
|
getBucketCors(callback?: (err: AWSError, data: S3.Types.GetBucketCorsOutput) => void): Request<S3.Types.GetBucketCorsOutput, AWSError>;
|
|
228
228
|
/**
|
|
@@ -346,11 +346,11 @@ declare class S3 extends S3Customizations {
|
|
|
346
346
|
*/
|
|
347
347
|
getBucketRequestPayment(callback?: (err: AWSError, data: S3.Types.GetBucketRequestPaymentOutput) => void): Request<S3.Types.GetBucketRequestPaymentOutput, AWSError>;
|
|
348
348
|
/**
|
|
349
|
-
* Returns the tag set associated with the bucket. To use this operation, you must have permission to perform the s3:GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others. GetBucketTagging has the following special error: Error code:
|
|
349
|
+
* Returns the tag set associated with the bucket. To use this operation, you must have permission to perform the s3:GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others. GetBucketTagging has the following special error: Error code: NoSuchTagSet Description: There is no tag set associated with the bucket. The following operations are related to GetBucketTagging: PutBucketTagging DeleteBucketTagging
|
|
350
350
|
*/
|
|
351
351
|
getBucketTagging(params: S3.Types.GetBucketTaggingRequest, callback?: (err: AWSError, data: S3.Types.GetBucketTaggingOutput) => void): Request<S3.Types.GetBucketTaggingOutput, AWSError>;
|
|
352
352
|
/**
|
|
353
|
-
* Returns the tag set associated with the bucket. To use this operation, you must have permission to perform the s3:GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others. GetBucketTagging has the following special error: Error code:
|
|
353
|
+
* Returns the tag set associated with the bucket. To use this operation, you must have permission to perform the s3:GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others. GetBucketTagging has the following special error: Error code: NoSuchTagSet Description: There is no tag set associated with the bucket. The following operations are related to GetBucketTagging: PutBucketTagging DeleteBucketTagging
|
|
354
354
|
*/
|
|
355
355
|
getBucketTagging(callback?: (err: AWSError, data: S3.Types.GetBucketTaggingOutput) => void): Request<S3.Types.GetBucketTaggingOutput, AWSError>;
|
|
356
356
|
/**
|
|
@@ -370,51 +370,59 @@ declare class S3 extends S3Customizations {
|
|
|
370
370
|
*/
|
|
371
371
|
getBucketWebsite(callback?: (err: AWSError, data: S3.Types.GetBucketWebsiteOutput) => void): Request<S3.Types.GetBucketWebsiteOutput, AWSError>;
|
|
372
372
|
/**
|
|
373
|
-
* Retrieves objects from Amazon S3. To use GET, you must have READ access to the object. If you grant READ access to the anonymous user, you can return the object without using an authorization header. An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg, you can name it photos/2006/February/sample.jpg. To get an object from such a logical hierarchy, specify the full key name for the object in the GET operation. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the resource as /photos/2006/February/sample.jpg. For a path-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification.
|
|
373
|
+
* Retrieves objects from Amazon S3. To use GET, you must have READ access to the object. If you grant READ access to the anonymous user, you can return the object without using an authorization header. An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg, you can name it photos/2006/February/sample.jpg. To get an object from such a logical hierarchy, specify the full key name for the object in the GET operation. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the resource as /photos/2006/February/sample.jpg. For a path-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification. For more information about returning the ACL of an object, see GetObjectAcl. If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this action returns an InvalidObjectStateError error. For information about restoring archived objects, see Restoring Archived Objects. Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers: x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys). Assuming you have the relevant permission to read object tags, the response also returns the x-amz-tagging-count header that provides the count of number of tags associated with the object. You can use GetObjectTagging to retrieve the tag set associated with an object. Permissions You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission. If you have the s3:ListBucket permission on the bucket, Amazon S3 will return an HTTP status code 404 ("no such key") error. If you don’t have the s3:ListBucket permission, Amazon S3 will return an HTTP status code 403 ("access denied") error. Versioning By default, the GET action returns the current version of an object. To return a different version, use the versionId subresource. If you supply a versionId, you need the s3:GetObjectVersion permission to access a specific version of an object. If you request a specific version, you do not need to have the s3:GetObject permission. If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response. For more information about versioning, see PutBucketVersioning. Overriding Response Header Values There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request. You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are Content-Type, Content-Language, Expires, Cache-Control, Content-Disposition, and Content-Encoding. To override these header values in the GET response, you use the following request parameters. You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request. response-content-type response-content-language response-expires response-cache-control response-content-disposition response-content-encoding Additional Considerations about Request Headers If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; then, S3 returns 200 OK and the data requested. If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified response code. For more information about conditional requests, see RFC 7232. The following operations are related to GetObject: ListBuckets GetObjectAcl
|
|
374
374
|
*/
|
|
375
375
|
getObject(params: S3.Types.GetObjectRequest, callback?: (err: AWSError, data: S3.Types.GetObjectOutput) => void): Request<S3.Types.GetObjectOutput, AWSError>;
|
|
376
376
|
/**
|
|
377
|
-
* Retrieves objects from Amazon S3. To use GET, you must have READ access to the object. If you grant READ access to the anonymous user, you can return the object without using an authorization header. An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg, you can name it photos/2006/February/sample.jpg. To get an object from such a logical hierarchy, specify the full key name for the object in the GET operation. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the resource as /photos/2006/February/sample.jpg. For a path-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification.
|
|
377
|
+
* Retrieves objects from Amazon S3. To use GET, you must have READ access to the object. If you grant READ access to the anonymous user, you can return the object without using an authorization header. An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg, you can name it photos/2006/February/sample.jpg. To get an object from such a logical hierarchy, specify the full key name for the object in the GET operation. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the resource as /photos/2006/February/sample.jpg. For a path-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification. For more information about returning the ACL of an object, see GetObjectAcl. If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this action returns an InvalidObjectStateError error. For information about restoring archived objects, see Restoring Archived Objects. Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers: x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys). Assuming you have the relevant permission to read object tags, the response also returns the x-amz-tagging-count header that provides the count of number of tags associated with the object. You can use GetObjectTagging to retrieve the tag set associated with an object. Permissions You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission. If you have the s3:ListBucket permission on the bucket, Amazon S3 will return an HTTP status code 404 ("no such key") error. If you don’t have the s3:ListBucket permission, Amazon S3 will return an HTTP status code 403 ("access denied") error. Versioning By default, the GET action returns the current version of an object. To return a different version, use the versionId subresource. If you supply a versionId, you need the s3:GetObjectVersion permission to access a specific version of an object. If you request a specific version, you do not need to have the s3:GetObject permission. If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response. For more information about versioning, see PutBucketVersioning. Overriding Response Header Values There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request. You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are Content-Type, Content-Language, Expires, Cache-Control, Content-Disposition, and Content-Encoding. To override these header values in the GET response, you use the following request parameters. You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request. response-content-type response-content-language response-expires response-cache-control response-content-disposition response-content-encoding Additional Considerations about Request Headers If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; then, S3 returns 200 OK and the data requested. If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified response code. For more information about conditional requests, see RFC 7232. The following operations are related to GetObject: ListBuckets GetObjectAcl
|
|
378
378
|
*/
|
|
379
379
|
getObject(callback?: (err: AWSError, data: S3.Types.GetObjectOutput) => void): Request<S3.Types.GetObjectOutput, AWSError>;
|
|
380
380
|
/**
|
|
381
|
-
* Returns the access control list (ACL) of an object. To use this operation, you must have READ_ACP access to the object. This action is not supported by Amazon S3 on Outposts. Versioning By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource. If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the bucket-owner-full-control ACL with the owner being the account that created the bucket. For more information, see Controlling object ownership and disabling ACLs in the Amazon S3 User Guide. The following operations are related to GetObjectAcl: GetObject DeleteObject PutObject
|
|
381
|
+
* Returns the access control list (ACL) of an object. To use this operation, you must have s3:GetObjectAcl permissions or READ_ACP access to the object. For more information, see Mapping of ACL permissions and access policy permissions in the Amazon S3 User Guide This action is not supported by Amazon S3 on Outposts. Versioning By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource. If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the bucket-owner-full-control ACL with the owner being the account that created the bucket. For more information, see Controlling object ownership and disabling ACLs in the Amazon S3 User Guide. The following operations are related to GetObjectAcl: GetObject GetObjectAttributes DeleteObject PutObject
|
|
382
382
|
*/
|
|
383
383
|
getObjectAcl(params: S3.Types.GetObjectAclRequest, callback?: (err: AWSError, data: S3.Types.GetObjectAclOutput) => void): Request<S3.Types.GetObjectAclOutput, AWSError>;
|
|
384
384
|
/**
|
|
385
|
-
* Returns the access control list (ACL) of an object. To use this operation, you must have READ_ACP access to the object. This action is not supported by Amazon S3 on Outposts. Versioning By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource. If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the bucket-owner-full-control ACL with the owner being the account that created the bucket. For more information, see Controlling object ownership and disabling ACLs in the Amazon S3 User Guide. The following operations are related to GetObjectAcl: GetObject DeleteObject PutObject
|
|
385
|
+
* Returns the access control list (ACL) of an object. To use this operation, you must have s3:GetObjectAcl permissions or READ_ACP access to the object. For more information, see Mapping of ACL permissions and access policy permissions in the Amazon S3 User Guide This action is not supported by Amazon S3 on Outposts. Versioning By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource. If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the bucket-owner-full-control ACL with the owner being the account that created the bucket. For more information, see Controlling object ownership and disabling ACLs in the Amazon S3 User Guide. The following operations are related to GetObjectAcl: GetObject GetObjectAttributes DeleteObject PutObject
|
|
386
386
|
*/
|
|
387
387
|
getObjectAcl(callback?: (err: AWSError, data: S3.Types.GetObjectAclOutput) => void): Request<S3.Types.GetObjectAclOutput, AWSError>;
|
|
388
388
|
/**
|
|
389
|
-
*
|
|
389
|
+
* Retrieves all the metadata from an object without returning the object itself. This action is useful if you're interested only in an object's metadata. To use GetObjectAttributes, you must have READ access to the object. GetObjectAttributes combines the functionality of GetObjectAcl, GetObjectLegalHold, GetObjectLockConfiguration, GetObjectRetention, GetObjectTagging, HeadObject, and ListParts. All of the data returned with each of those individual calls can be returned with a single call to GetObjectAttributes. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers: x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide. Encryption request headers, such as x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with Amazon Web Services KMS keys stored in Amazon Web Services Key Management Service (SSE-KMS) or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). If your object does use these types of keys, you'll get an HTTP 400 Bad Request error. The last modified property in this case is the creation date of the object. Consider the following when using request headers: If both of the If-Match and If-Unmodified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 200 OK and the data requested: If-Match condition evaluates to true. If-Unmodified-Since condition evaluates to false. If both of the If-None-Match and If-Modified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 304 Not Modified: If-None-Match condition evaluates to false. If-Modified-Since condition evaluates to true. For more information about conditional requests, see RFC 7232. Permissions The permissions that you need to use this operation depend on whether the bucket is versioned. If the bucket is versioned, you need both the s3:GetObjectVersion and s3:GetObjectVersionAttributes permissions for this operation. If the bucket is not versioned, you need the s3:GetObject and s3:GetObjectAttributes permissions. For more information, see Specifying Permissions in a Policy in the Amazon S3 User Guide. If the object that you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission. If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 Not Found ("no such key") error. If you don't have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Forbidden ("access denied") error. The following actions are related to GetObjectAttributes: GetObject GetObjectAcl GetObjectLegalHold GetObjectLockConfiguration GetObjectRetention GetObjectTagging HeadObject ListParts
|
|
390
|
+
*/
|
|
391
|
+
getObjectAttributes(params: S3.Types.GetObjectAttributesRequest, callback?: (err: AWSError, data: S3.Types.GetObjectAttributesOutput) => void): Request<S3.Types.GetObjectAttributesOutput, AWSError>;
|
|
392
|
+
/**
|
|
393
|
+
* Retrieves all the metadata from an object without returning the object itself. This action is useful if you're interested only in an object's metadata. To use GetObjectAttributes, you must have READ access to the object. GetObjectAttributes combines the functionality of GetObjectAcl, GetObjectLegalHold, GetObjectLockConfiguration, GetObjectRetention, GetObjectTagging, HeadObject, and ListParts. All of the data returned with each of those individual calls can be returned with a single call to GetObjectAttributes. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers: x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide. Encryption request headers, such as x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with Amazon Web Services KMS keys stored in Amazon Web Services Key Management Service (SSE-KMS) or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). If your object does use these types of keys, you'll get an HTTP 400 Bad Request error. The last modified property in this case is the creation date of the object. Consider the following when using request headers: If both of the If-Match and If-Unmodified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 200 OK and the data requested: If-Match condition evaluates to true. If-Unmodified-Since condition evaluates to false. If both of the If-None-Match and If-Modified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 304 Not Modified: If-None-Match condition evaluates to false. If-Modified-Since condition evaluates to true. For more information about conditional requests, see RFC 7232. Permissions The permissions that you need to use this operation depend on whether the bucket is versioned. If the bucket is versioned, you need both the s3:GetObjectVersion and s3:GetObjectVersionAttributes permissions for this operation. If the bucket is not versioned, you need the s3:GetObject and s3:GetObjectAttributes permissions. For more information, see Specifying Permissions in a Policy in the Amazon S3 User Guide. If the object that you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission. If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 Not Found ("no such key") error. If you don't have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Forbidden ("access denied") error. The following actions are related to GetObjectAttributes: GetObject GetObjectAcl GetObjectLegalHold GetObjectLockConfiguration GetObjectRetention GetObjectTagging HeadObject ListParts
|
|
394
|
+
*/
|
|
395
|
+
getObjectAttributes(callback?: (err: AWSError, data: S3.Types.GetObjectAttributesOutput) => void): Request<S3.Types.GetObjectAttributesOutput, AWSError>;
|
|
396
|
+
/**
|
|
397
|
+
* Gets an object's current legal hold status. For more information, see Locking Objects. This action is not supported by Amazon S3 on Outposts. The following action is related to GetObjectLegalHold: GetObjectAttributes
|
|
390
398
|
*/
|
|
391
399
|
getObjectLegalHold(params: S3.Types.GetObjectLegalHoldRequest, callback?: (err: AWSError, data: S3.Types.GetObjectLegalHoldOutput) => void): Request<S3.Types.GetObjectLegalHoldOutput, AWSError>;
|
|
392
400
|
/**
|
|
393
|
-
* Gets an object's current
|
|
401
|
+
* Gets an object's current legal hold status. For more information, see Locking Objects. This action is not supported by Amazon S3 on Outposts. The following action is related to GetObjectLegalHold: GetObjectAttributes
|
|
394
402
|
*/
|
|
395
403
|
getObjectLegalHold(callback?: (err: AWSError, data: S3.Types.GetObjectLegalHoldOutput) => void): Request<S3.Types.GetObjectLegalHoldOutput, AWSError>;
|
|
396
404
|
/**
|
|
397
|
-
* Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.
|
|
405
|
+
* Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects. The following action is related to GetObjectLockConfiguration: GetObjectAttributes
|
|
398
406
|
*/
|
|
399
407
|
getObjectLockConfiguration(params: S3.Types.GetObjectLockConfigurationRequest, callback?: (err: AWSError, data: S3.Types.GetObjectLockConfigurationOutput) => void): Request<S3.Types.GetObjectLockConfigurationOutput, AWSError>;
|
|
400
408
|
/**
|
|
401
|
-
* Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.
|
|
409
|
+
* Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects. The following action is related to GetObjectLockConfiguration: GetObjectAttributes
|
|
402
410
|
*/
|
|
403
411
|
getObjectLockConfiguration(callback?: (err: AWSError, data: S3.Types.GetObjectLockConfigurationOutput) => void): Request<S3.Types.GetObjectLockConfigurationOutput, AWSError>;
|
|
404
412
|
/**
|
|
405
|
-
* Retrieves an object's retention settings. For more information, see Locking Objects. This action is not supported by Amazon S3 on Outposts.
|
|
413
|
+
* Retrieves an object's retention settings. For more information, see Locking Objects. This action is not supported by Amazon S3 on Outposts. The following action is related to GetObjectRetention: GetObjectAttributes
|
|
406
414
|
*/
|
|
407
415
|
getObjectRetention(params: S3.Types.GetObjectRetentionRequest, callback?: (err: AWSError, data: S3.Types.GetObjectRetentionOutput) => void): Request<S3.Types.GetObjectRetentionOutput, AWSError>;
|
|
408
416
|
/**
|
|
409
|
-
* Retrieves an object's retention settings. For more information, see Locking Objects. This action is not supported by Amazon S3 on Outposts.
|
|
417
|
+
* Retrieves an object's retention settings. For more information, see Locking Objects. This action is not supported by Amazon S3 on Outposts. The following action is related to GetObjectRetention: GetObjectAttributes
|
|
410
418
|
*/
|
|
411
419
|
getObjectRetention(callback?: (err: AWSError, data: S3.Types.GetObjectRetentionOutput) => void): Request<S3.Types.GetObjectRetentionOutput, AWSError>;
|
|
412
420
|
/**
|
|
413
|
-
* Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object. To use this operation, you must have permission to perform the s3:GetObjectTagging action. By default, the GET action returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the s3:GetObjectVersionTagging action. By default, the bucket owner has this permission and can grant this permission to others. For information about the Amazon S3 object tagging feature, see Object Tagging. The following
|
|
421
|
+
* Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object. To use this operation, you must have permission to perform the s3:GetObjectTagging action. By default, the GET action returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the s3:GetObjectVersionTagging action. By default, the bucket owner has this permission and can grant this permission to others. For information about the Amazon S3 object tagging feature, see Object Tagging. The following actions are related to GetObjectTagging: DeleteObjectTagging GetObjectAttributes PutObjectTagging
|
|
414
422
|
*/
|
|
415
423
|
getObjectTagging(params: S3.Types.GetObjectTaggingRequest, callback?: (err: AWSError, data: S3.Types.GetObjectTaggingOutput) => void): Request<S3.Types.GetObjectTaggingOutput, AWSError>;
|
|
416
424
|
/**
|
|
417
|
-
* Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object. To use this operation, you must have permission to perform the s3:GetObjectTagging action. By default, the GET action returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the s3:GetObjectVersionTagging action. By default, the bucket owner has this permission and can grant this permission to others. For information about the Amazon S3 object tagging feature, see Object Tagging. The following
|
|
425
|
+
* Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object. To use this operation, you must have permission to perform the s3:GetObjectTagging action. By default, the GET action returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the s3:GetObjectVersionTagging action. By default, the bucket owner has this permission and can grant this permission to others. For information about the Amazon S3 object tagging feature, see Object Tagging. The following actions are related to GetObjectTagging: DeleteObjectTagging GetObjectAttributes PutObjectTagging
|
|
418
426
|
*/
|
|
419
427
|
getObjectTagging(callback?: (err: AWSError, data: S3.Types.GetObjectTaggingOutput) => void): Request<S3.Types.GetObjectTaggingOutput, AWSError>;
|
|
420
428
|
/**
|
|
@@ -442,11 +450,11 @@ declare class S3 extends S3Customizations {
|
|
|
442
450
|
*/
|
|
443
451
|
headBucket(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
444
452
|
/**
|
|
445
|
-
* The HEAD action retrieves metadata from an object without returning the object itself. This action is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. A HEAD request has the same options as a GET action on an object. The response is identical to the GET response except that there is no response body. Because of this, if the HEAD request generates an error, it returns a generic 404 Not Found or 403 Forbidden code. It is not possible to retrieve the exact exception beyond these error codes. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers: x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys). Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error. The last modified property in this case is the creation date of the object. Request headers are limited to 8 KB in size. For more information, see Common Request Headers. Consider the following when using request headers: Consideration 1 – If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; Then Amazon S3 returns 200 OK and the data requested. Consideration 2 – If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; Then Amazon S3 returns the 304 Not Modified response code. For more information about conditional requests, see RFC 7232. Permissions You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission. If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 ("no such key") error. If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 ("access denied") error. The following
|
|
453
|
+
* The HEAD action retrieves metadata from an object without returning the object itself. This action is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. A HEAD request has the same options as a GET action on an object. The response is identical to the GET response except that there is no response body. Because of this, if the HEAD request generates an error, it returns a generic 404 Not Found or 403 Forbidden code. It is not possible to retrieve the exact exception beyond these error codes. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers: x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys). Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error. The last modified property in this case is the creation date of the object. Request headers are limited to 8 KB in size. For more information, see Common Request Headers. Consider the following when using request headers: Consideration 1 – If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; Then Amazon S3 returns 200 OK and the data requested. Consideration 2 – If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; Then Amazon S3 returns the 304 Not Modified response code. For more information about conditional requests, see RFC 7232. Permissions You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission. If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 ("no such key") error. If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 ("access denied") error. The following actions are related to HeadObject: GetObject GetObjectAttributes
|
|
446
454
|
*/
|
|
447
455
|
headObject(params: S3.Types.HeadObjectRequest, callback?: (err: AWSError, data: S3.Types.HeadObjectOutput) => void): Request<S3.Types.HeadObjectOutput, AWSError>;
|
|
448
456
|
/**
|
|
449
|
-
* The HEAD action retrieves metadata from an object without returning the object itself. This action is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. A HEAD request has the same options as a GET action on an object. The response is identical to the GET response except that there is no response body. Because of this, if the HEAD request generates an error, it returns a generic 404 Not Found or 403 Forbidden code. It is not possible to retrieve the exact exception beyond these error codes. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers: x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys). Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error. The last modified property in this case is the creation date of the object. Request headers are limited to 8 KB in size. For more information, see Common Request Headers. Consider the following when using request headers: Consideration 1 – If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; Then Amazon S3 returns 200 OK and the data requested. Consideration 2 – If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; Then Amazon S3 returns the 304 Not Modified response code. For more information about conditional requests, see RFC 7232. Permissions You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission. If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 ("no such key") error. If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 ("access denied") error. The following
|
|
457
|
+
* The HEAD action retrieves metadata from an object without returning the object itself. This action is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. A HEAD request has the same options as a GET action on an object. The response is identical to the GET response except that there is no response body. Because of this, if the HEAD request generates an error, it returns a generic 404 Not Found or 403 Forbidden code. It is not possible to retrieve the exact exception beyond these error codes. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers: x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys). Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error. The last modified property in this case is the creation date of the object. Request headers are limited to 8 KB in size. For more information, see Common Request Headers. Consider the following when using request headers: Consideration 1 – If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; Then Amazon S3 returns 200 OK and the data requested. Consideration 2 – If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; Then Amazon S3 returns the 304 Not Modified response code. For more information about conditional requests, see RFC 7232. Permissions You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission. If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 ("no such key") error. If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 ("access denied") error. The following actions are related to HeadObject: GetObject GetObjectAttributes
|
|
450
458
|
*/
|
|
451
459
|
headObject(callback?: (err: AWSError, data: S3.Types.HeadObjectOutput) => void): Request<S3.Types.HeadObjectOutput, AWSError>;
|
|
452
460
|
/**
|
|
@@ -482,7 +490,7 @@ declare class S3 extends S3Customizations {
|
|
|
482
490
|
*/
|
|
483
491
|
listBucketMetricsConfigurations(callback?: (err: AWSError, data: S3.Types.ListBucketMetricsConfigurationsOutput) => void): Request<S3.Types.ListBucketMetricsConfigurationsOutput, AWSError>;
|
|
484
492
|
/**
|
|
485
|
-
* Returns a list of all buckets owned by the authenticated sender of the request.
|
|
493
|
+
* Returns a list of all buckets owned by the authenticated sender of the request. To use this operation, you must have the s3:ListAllMyBuckets permission.
|
|
486
494
|
*/
|
|
487
495
|
listBuckets(callback?: (err: AWSError, data: S3.Types.ListBucketsOutput) => void): Request<S3.Types.ListBucketsOutput, AWSError>;
|
|
488
496
|
/**
|
|
@@ -518,11 +526,11 @@ declare class S3 extends S3Customizations {
|
|
|
518
526
|
*/
|
|
519
527
|
listObjectsV2(callback?: (err: AWSError, data: S3.Types.ListObjectsV2Output) => void): Request<S3.Types.ListObjectsV2Output, AWSError>;
|
|
520
528
|
/**
|
|
521
|
-
* Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the max-parts request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with the value of true, and a NextPartNumberMarker element. In subsequent ListParts requests you can include the part-number-marker query string parameter and set its value to the NextPartNumberMarker field value from the previous response. For more information on multipart uploads, see Uploading Objects Using Multipart Upload. For information on permissions required to use the multipart upload API, see Multipart Upload and Permissions. The following operations are related to ListParts: CreateMultipartUpload UploadPart CompleteMultipartUpload AbortMultipartUpload ListMultipartUploads
|
|
529
|
+
* Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the max-parts request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with the value of true, and a NextPartNumberMarker element. In subsequent ListParts requests you can include the part-number-marker query string parameter and set its value to the NextPartNumberMarker field value from the previous response. If the upload was created using a checksum algorithm, you will need to have permission to the kms:Decrypt action for the request to succeed. For more information on multipart uploads, see Uploading Objects Using Multipart Upload. For information on permissions required to use the multipart upload API, see Multipart Upload and Permissions. The following operations are related to ListParts: CreateMultipartUpload UploadPart CompleteMultipartUpload AbortMultipartUpload GetObjectAttributes ListMultipartUploads
|
|
522
530
|
*/
|
|
523
531
|
listParts(params: S3.Types.ListPartsRequest, callback?: (err: AWSError, data: S3.Types.ListPartsOutput) => void): Request<S3.Types.ListPartsOutput, AWSError>;
|
|
524
532
|
/**
|
|
525
|
-
* Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the max-parts request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with the value of true, and a NextPartNumberMarker element. In subsequent ListParts requests you can include the part-number-marker query string parameter and set its value to the NextPartNumberMarker field value from the previous response. For more information on multipart uploads, see Uploading Objects Using Multipart Upload. For information on permissions required to use the multipart upload API, see Multipart Upload and Permissions. The following operations are related to ListParts: CreateMultipartUpload UploadPart CompleteMultipartUpload AbortMultipartUpload ListMultipartUploads
|
|
533
|
+
* Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the max-parts request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with the value of true, and a NextPartNumberMarker element. In subsequent ListParts requests you can include the part-number-marker query string parameter and set its value to the NextPartNumberMarker field value from the previous response. If the upload was created using a checksum algorithm, you will need to have permission to the kms:Decrypt action for the request to succeed. For more information on multipart uploads, see Uploading Objects Using Multipart Upload. For information on permissions required to use the multipart upload API, see Multipart Upload and Permissions. The following operations are related to ListParts: CreateMultipartUpload UploadPart CompleteMultipartUpload AbortMultipartUpload GetObjectAttributes ListMultipartUploads
|
|
526
534
|
*/
|
|
527
535
|
listParts(callback?: (err: AWSError, data: S3.Types.ListPartsOutput) => void): Request<S3.Types.ListPartsOutput, AWSError>;
|
|
528
536
|
/**
|
|
@@ -558,11 +566,11 @@ declare class S3 extends S3Customizations {
|
|
|
558
566
|
*/
|
|
559
567
|
putBucketCors(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
560
568
|
/**
|
|
561
|
-
* This action uses the encryption subresource to configure default encryption and Amazon S3 Bucket Key for an existing bucket. Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). If you specify default encryption using SSE-KMS, you can also configure Amazon S3 Bucket Key. For information about default encryption, see Amazon S3 default bucket encryption in the Amazon S3 User Guide. For more information about S3 Bucket Keys, see Amazon S3 Bucket Keys in the Amazon S3 User Guide. This action requires Amazon Web Services Signature Version 4. For more information, see Authenticating Requests (Amazon Web Services Signature Version 4). To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide. Related Resources GetBucketEncryption DeleteBucketEncryption
|
|
569
|
+
* This action uses the encryption subresource to configure default encryption and Amazon S3 Bucket Key for an existing bucket. Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). If you specify default encryption using SSE-KMS, you can also configure Amazon S3 Bucket Key. When the default encryption is SSE-KMS, if you upload an object to the bucket and do not specify the KMS key to use for encryption, Amazon S3 uses the default Amazon Web Services managed KMS key for your account. For information about default encryption, see Amazon S3 default bucket encryption in the Amazon S3 User Guide. For more information about S3 Bucket Keys, see Amazon S3 Bucket Keys in the Amazon S3 User Guide. This action requires Amazon Web Services Signature Version 4. For more information, see Authenticating Requests (Amazon Web Services Signature Version 4). To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide. Related Resources GetBucketEncryption DeleteBucketEncryption
|
|
562
570
|
*/
|
|
563
571
|
putBucketEncryption(params: S3.Types.PutBucketEncryptionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
564
572
|
/**
|
|
565
|
-
* This action uses the encryption subresource to configure default encryption and Amazon S3 Bucket Key for an existing bucket. Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). If you specify default encryption using SSE-KMS, you can also configure Amazon S3 Bucket Key. For information about default encryption, see Amazon S3 default bucket encryption in the Amazon S3 User Guide. For more information about S3 Bucket Keys, see Amazon S3 Bucket Keys in the Amazon S3 User Guide. This action requires Amazon Web Services Signature Version 4. For more information, see Authenticating Requests (Amazon Web Services Signature Version 4). To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide. Related Resources GetBucketEncryption DeleteBucketEncryption
|
|
573
|
+
* This action uses the encryption subresource to configure default encryption and Amazon S3 Bucket Key for an existing bucket. Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). If you specify default encryption using SSE-KMS, you can also configure Amazon S3 Bucket Key. When the default encryption is SSE-KMS, if you upload an object to the bucket and do not specify the KMS key to use for encryption, Amazon S3 uses the default Amazon Web Services managed KMS key for your account. For information about default encryption, see Amazon S3 default bucket encryption in the Amazon S3 User Guide. For more information about S3 Bucket Keys, see Amazon S3 Bucket Keys in the Amazon S3 User Guide. This action requires Amazon Web Services Signature Version 4. For more information, see Authenticating Requests (Amazon Web Services Signature Version 4). To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide. Related Resources GetBucketEncryption DeleteBucketEncryption
|
|
566
574
|
*/
|
|
567
575
|
putBucketEncryption(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
568
576
|
/**
|
|
@@ -590,11 +598,11 @@ declare class S3 extends S3Customizations {
|
|
|
590
598
|
*/
|
|
591
599
|
putBucketLifecycle(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
592
600
|
/**
|
|
593
|
-
* Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Managing your storage lifecycle. Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle. Rules You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. Each rule consists of the following: Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both. Status whether the rule is in effect. One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions. For more information, see Object Lifecycle Management and Lifecycle Configuration Elements. Permissions By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission. You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:
|
|
601
|
+
* Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. Keep in mind that this will overwrite an existing lifecycle configuration, so if you want to retain any configuration details, they must be included in the new lifecycle configuration. For information about lifecycle configuration, see Managing your storage lifecycle. Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle. Rules You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle configuration can have up to 1,000 rules. This limit is not adjustable. Each rule consists of the following: Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both. Status whether the rule is in effect. One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions. For more information, see Object Lifecycle Management and Lifecycle Configuration Elements. Permissions By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission. You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions: s3:DeleteObject s3:DeleteObjectVersion s3:PutLifecycleConfiguration For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources. The following are related to PutBucketLifecycleConfiguration: Examples of Lifecycle Configuration GetBucketLifecycleConfiguration DeleteBucketLifecycle
|
|
594
602
|
*/
|
|
595
603
|
putBucketLifecycleConfiguration(params: S3.Types.PutBucketLifecycleConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
596
604
|
/**
|
|
597
|
-
* Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Managing your storage lifecycle. Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle. Rules You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. Each rule consists of the following: Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both. Status whether the rule is in effect. One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions. For more information, see Object Lifecycle Management and Lifecycle Configuration Elements. Permissions By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission. You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:
|
|
605
|
+
* Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. Keep in mind that this will overwrite an existing lifecycle configuration, so if you want to retain any configuration details, they must be included in the new lifecycle configuration. For information about lifecycle configuration, see Managing your storage lifecycle. Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle. Rules You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle configuration can have up to 1,000 rules. This limit is not adjustable. Each rule consists of the following: Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both. Status whether the rule is in effect. One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions. For more information, see Object Lifecycle Management and Lifecycle Configuration Elements. Permissions By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission. You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions: s3:DeleteObject s3:DeleteObjectVersion s3:PutLifecycleConfiguration For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources. The following are related to PutBucketLifecycleConfiguration: Examples of Lifecycle Configuration GetBucketLifecycleConfiguration DeleteBucketLifecycle
|
|
598
606
|
*/
|
|
599
607
|
putBucketLifecycleConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
600
608
|
/**
|
|
@@ -622,11 +630,11 @@ declare class S3 extends S3Customizations {
|
|
|
622
630
|
*/
|
|
623
631
|
putBucketNotification(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
624
632
|
/**
|
|
625
|
-
* Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications. Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type. By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty NotificationConfiguration. <NotificationConfiguration> </NotificationConfiguration> This action replaces the existing notification configuration with the configuration you include in the request body. After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events. You can disable notifications by adding the empty NotificationConfiguration element. By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with s3:PutBucketNotification permission. The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the configuration to your bucket. Responses If the configuration in the request body includes only one TopicConfiguration specifying only the s3:ReducedRedundancyLostObject event type, the response will also include the x-amz-sns-test-message-id header containing the message ID of the test notification sent to the topic. The following action is related to PutBucketNotificationConfiguration: GetBucketNotificationConfiguration
|
|
633
|
+
* Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications. Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type. By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty NotificationConfiguration. <NotificationConfiguration> </NotificationConfiguration> This action replaces the existing notification configuration with the configuration you include in the request body. After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events. You can disable notifications by adding the empty NotificationConfiguration element. For more information about the number of event notification configurations that you can create per bucket, see Amazon S3 service quotas in Amazon Web Services General Reference. By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with s3:PutBucketNotification permission. The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the configuration to your bucket. Responses If the configuration in the request body includes only one TopicConfiguration specifying only the s3:ReducedRedundancyLostObject event type, the response will also include the x-amz-sns-test-message-id header containing the message ID of the test notification sent to the topic. The following action is related to PutBucketNotificationConfiguration: GetBucketNotificationConfiguration
|
|
626
634
|
*/
|
|
627
635
|
putBucketNotificationConfiguration(params: S3.Types.PutBucketNotificationConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
628
636
|
/**
|
|
629
|
-
* Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications. Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type. By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty NotificationConfiguration. <NotificationConfiguration> </NotificationConfiguration> This action replaces the existing notification configuration with the configuration you include in the request body. After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events. You can disable notifications by adding the empty NotificationConfiguration element. By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with s3:PutBucketNotification permission. The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the configuration to your bucket. Responses If the configuration in the request body includes only one TopicConfiguration specifying only the s3:ReducedRedundancyLostObject event type, the response will also include the x-amz-sns-test-message-id header containing the message ID of the test notification sent to the topic. The following action is related to PutBucketNotificationConfiguration: GetBucketNotificationConfiguration
|
|
637
|
+
* Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications. Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type. By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty NotificationConfiguration. <NotificationConfiguration> </NotificationConfiguration> This action replaces the existing notification configuration with the configuration you include in the request body. After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events. You can disable notifications by adding the empty NotificationConfiguration element. For more information about the number of event notification configurations that you can create per bucket, see Amazon S3 service quotas in Amazon Web Services General Reference. By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with s3:PutBucketNotification permission. The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the configuration to your bucket. Responses If the configuration in the request body includes only one TopicConfiguration specifying only the s3:ReducedRedundancyLostObject event type, the response will also include the x-amz-sns-test-message-id header containing the message ID of the test notification sent to the topic. The following action is related to PutBucketNotificationConfiguration: GetBucketNotificationConfiguration
|
|
630
638
|
*/
|
|
631
639
|
putBucketNotificationConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
632
640
|
/**
|
|
@@ -670,11 +678,11 @@ declare class S3 extends S3Customizations {
|
|
|
670
678
|
*/
|
|
671
679
|
putBucketTagging(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
672
680
|
/**
|
|
673
|
-
* Sets the versioning state of an existing bucket.
|
|
681
|
+
* Sets the versioning state of an existing bucket. You can set the versioning state with one of the following values: Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID. Suspended—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null. If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value. In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner and want to enable MFA Delete in the bucket versioning configuration, you must include the x-amz-mfa request header and the Status and the MfaDelete request elements in a request to set the versioning state of the bucket. If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning. Related Resources CreateBucket DeleteBucket GetBucketVersioning
|
|
674
682
|
*/
|
|
675
683
|
putBucketVersioning(params: S3.Types.PutBucketVersioningRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
676
684
|
/**
|
|
677
|
-
* Sets the versioning state of an existing bucket.
|
|
685
|
+
* Sets the versioning state of an existing bucket. You can set the versioning state with one of the following values: Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID. Suspended—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null. If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value. In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner and want to enable MFA Delete in the bucket versioning configuration, you must include the x-amz-mfa request header and the Status and the MfaDelete request elements in a request to set the versioning state of the bucket. If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning. Related Resources CreateBucket DeleteBucket GetBucketVersioning
|
|
678
686
|
*/
|
|
679
687
|
putBucketVersioning(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
680
688
|
/**
|
|
@@ -702,11 +710,11 @@ declare class S3 extends S3Customizations {
|
|
|
702
710
|
*/
|
|
703
711
|
putObjectAcl(callback?: (err: AWSError, data: S3.Types.PutObjectAclOutput) => void): Request<S3.Types.PutObjectAclOutput, AWSError>;
|
|
704
712
|
/**
|
|
705
|
-
* Applies a
|
|
713
|
+
* Applies a legal hold configuration to the specified object. For more information, see Locking Objects. This action is not supported by Amazon S3 on Outposts.
|
|
706
714
|
*/
|
|
707
715
|
putObjectLegalHold(params: S3.Types.PutObjectLegalHoldRequest, callback?: (err: AWSError, data: S3.Types.PutObjectLegalHoldOutput) => void): Request<S3.Types.PutObjectLegalHoldOutput, AWSError>;
|
|
708
716
|
/**
|
|
709
|
-
* Applies a
|
|
717
|
+
* Applies a legal hold configuration to the specified object. For more information, see Locking Objects. This action is not supported by Amazon S3 on Outposts.
|
|
710
718
|
*/
|
|
711
719
|
putObjectLegalHold(callback?: (err: AWSError, data: S3.Types.PutObjectLegalHoldOutput) => void): Request<S3.Types.PutObjectLegalHoldOutput, AWSError>;
|
|
712
720
|
/**
|
|
@@ -718,11 +726,11 @@ declare class S3 extends S3Customizations {
|
|
|
718
726
|
*/
|
|
719
727
|
putObjectLockConfiguration(callback?: (err: AWSError, data: S3.Types.PutObjectLockConfigurationOutput) => void): Request<S3.Types.PutObjectLockConfigurationOutput, AWSError>;
|
|
720
728
|
/**
|
|
721
|
-
* Places an Object Retention configuration on an object. For more information, see Locking Objects. Users or accounts require the s3:PutObjectRetention permission in order to place an Object Retention configuration on objects. Bypassing a Governance Retention configuration requires the s3:BypassGovernanceRetention permission. This action is not supported by Amazon S3 on Outposts.
|
|
729
|
+
* Places an Object Retention configuration on an object. For more information, see Locking Objects. Users or accounts require the s3:PutObjectRetention permission in order to place an Object Retention configuration on objects. Bypassing a Governance Retention configuration requires the s3:BypassGovernanceRetention permission. This action is not supported by Amazon S3 on Outposts.
|
|
722
730
|
*/
|
|
723
731
|
putObjectRetention(params: S3.Types.PutObjectRetentionRequest, callback?: (err: AWSError, data: S3.Types.PutObjectRetentionOutput) => void): Request<S3.Types.PutObjectRetentionOutput, AWSError>;
|
|
724
732
|
/**
|
|
725
|
-
* Places an Object Retention configuration on an object. For more information, see Locking Objects. Users or accounts require the s3:PutObjectRetention permission in order to place an Object Retention configuration on objects. Bypassing a Governance Retention configuration requires the s3:BypassGovernanceRetention permission. This action is not supported by Amazon S3 on Outposts.
|
|
733
|
+
* Places an Object Retention configuration on an object. For more information, see Locking Objects. Users or accounts require the s3:PutObjectRetention permission in order to place an Object Retention configuration on objects. Bypassing a Governance Retention configuration requires the s3:BypassGovernanceRetention permission. This action is not supported by Amazon S3 on Outposts.
|
|
726
734
|
*/
|
|
727
735
|
putObjectRetention(callback?: (err: AWSError, data: S3.Types.PutObjectRetentionOutput) => void): Request<S3.Types.PutObjectRetentionOutput, AWSError>;
|
|
728
736
|
/**
|
|
@@ -742,11 +750,11 @@ declare class S3 extends S3Customizations {
|
|
|
742
750
|
*/
|
|
743
751
|
putPublicAccessBlock(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
744
752
|
/**
|
|
745
|
-
* Restores an archived copy of an object back into Amazon S3 This action is not supported by Amazon S3 on Outposts. This action performs the following types of requests: select - Perform a select query on an archived object restore an archive - Restore an archived object To use this operation, you must have permissions to perform the s3:RestoreObject action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide. Querying Archives with Select Requests You use a select type of request to perform SQL queries on archived objects. The archived objects that are being queried by the select request must be formatted as uncompressed comma-separated values (CSV) files. You can run queries and custom analytics on your archived data without having to restore your data to a hotter Amazon S3 tier. For an overview about select requests, see Querying Archived Objects in the Amazon S3 User Guide. When making a select request, do the following: Define an output location for the select query's output. This must be an Amazon S3 bucket in the same Amazon Web Services Region as the bucket that contains the archive object that is being queried. The Amazon Web Services account that initiates the job must have permissions to write to the S3 bucket. You can specify the storage class and encryption for the output objects stored in the bucket. For more information about output, see Querying Archived Objects in the Amazon S3 User Guide. For more information about the S3 structure in the request body, see the following: PutObject Managing Access with ACLs in the Amazon S3 User Guide Protecting Data Using Server-Side Encryption in the Amazon S3 User Guide Define the SQL expression for the SELECT type of restoration for your query in the request body's SelectParameters structure. You can use expressions like the following examples. The following expression returns all records from the specified object. SELECT * FROM Object Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers. SELECT s._1, s._2 FROM Object s WHERE s._3 > 100 If you have headers and you set the fileHeaderInfo in the CSV structure in the request body to USE, you can specify headers in the query. (If you set the fileHeaderInfo field to IGNORE, the first row is skipped for the query.) You cannot mix ordinal positions with header column names. SELECT s.Id, s.FirstName, s.SSN FROM S3Object s For more information about using SQL with S3 Glacier Select restore, see SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon S3 User Guide. When making a select request, you can also do the following: To expedite your queries, specify the Expedited tier. For more information about tiers, see "Restoring Archives," later in this topic. Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results. The following are additional important facts about the select feature: The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle policy. You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't deduplicate requests, so avoid issuing duplicate requests. Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response 409. Restoring objects Objects that you archive to the S3 Glacier or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time. For objects in Archive Access or Deep Archive Access tiers you must first initiate a restore request, and then wait until the object is moved into the Frequent Access tier. For objects in S3 Glacier or S3 Glacier Deep Archive storage classes you must first initiate a restore request, and then wait until a temporary copy of the object is available. To access an archived object, you must restore the object for the duration (number of days) that you specify. To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version. When restoring an archived object (or using a select request), you can specify one of the following data access tier options in the Tier element of the request body:
|
|
753
|
+
* Restores an archived copy of an object back into Amazon S3 This action is not supported by Amazon S3 on Outposts. This action performs the following types of requests: select - Perform a select query on an archived object restore an archive - Restore an archived object To use this operation, you must have permissions to perform the s3:RestoreObject action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide. Querying Archives with Select Requests You use a select type of request to perform SQL queries on archived objects. The archived objects that are being queried by the select request must be formatted as uncompressed comma-separated values (CSV) files. You can run queries and custom analytics on your archived data without having to restore your data to a hotter Amazon S3 tier. For an overview about select requests, see Querying Archived Objects in the Amazon S3 User Guide. When making a select request, do the following: Define an output location for the select query's output. This must be an Amazon S3 bucket in the same Amazon Web Services Region as the bucket that contains the archive object that is being queried. The Amazon Web Services account that initiates the job must have permissions to write to the S3 bucket. You can specify the storage class and encryption for the output objects stored in the bucket. For more information about output, see Querying Archived Objects in the Amazon S3 User Guide. For more information about the S3 structure in the request body, see the following: PutObject Managing Access with ACLs in the Amazon S3 User Guide Protecting Data Using Server-Side Encryption in the Amazon S3 User Guide Define the SQL expression for the SELECT type of restoration for your query in the request body's SelectParameters structure. You can use expressions like the following examples. The following expression returns all records from the specified object. SELECT * FROM Object Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers. SELECT s._1, s._2 FROM Object s WHERE s._3 > 100 If you have headers and you set the fileHeaderInfo in the CSV structure in the request body to USE, you can specify headers in the query. (If you set the fileHeaderInfo field to IGNORE, the first row is skipped for the query.) You cannot mix ordinal positions with header column names. SELECT s.Id, s.FirstName, s.SSN FROM S3Object s For more information about using SQL with S3 Glacier Select restore, see SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon S3 User Guide. When making a select request, you can also do the following: To expedite your queries, specify the Expedited tier. For more information about tiers, see "Restoring Archives," later in this topic. Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results. The following are additional important facts about the select feature: The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle policy. You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't deduplicate requests, so avoid issuing duplicate requests. Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response 409. Restoring objects Objects that you archive to the S3 Glacier or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time. For objects in Archive Access or Deep Archive Access tiers you must first initiate a restore request, and then wait until the object is moved into the Frequent Access tier. For objects in S3 Glacier or S3 Glacier Deep Archive storage classes you must first initiate a restore request, and then wait until a temporary copy of the object is available. To access an archived object, you must restore the object for the duration (number of days) that you specify. To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version. When restoring an archived object (or using a select request), you can specify one of the following data access tier options in the Tier element of the request body: Expedited - Expedited retrievals allow you to quickly access your data stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests for a subset of archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals is typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard - Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for retrieval requests that do not specify the retrieval option. Standard retrievals typically finish within 3–5 hours for objects stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in S3 Intelligent-Tiering. Bulk - Bulk retrievals are the lowest-cost retrieval option in S3 Glacier, enabling you to retrieve large amounts, even petabytes, of data inexpensively. Bulk retrievals typically finish within 5–12 hours for objects stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Bulk retrievals are free for objects stored in S3 Intelligent-Tiering. For more information about archive retrieval options and provisioned capacity for Expedited data access, see Restoring Archived Objects in the Amazon S3 User Guide. You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the Amazon S3 User Guide. To get the status of object restoration, you can send a HEAD request. Operations return the x-amz-restore header, which provides information about the restoration status, in the response. You can use Amazon S3 event notifications to notify you when a restore is initiated or completed. For more information, see Configuring Amazon S3 Event Notifications in the Amazon S3 User Guide. After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object. If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management in Amazon S3 User Guide. Responses A successful action returns either the 200 OK or 202 Accepted status code. If the object is not previously restored, then Amazon S3 returns 202 Accepted in the response. If the object is previously restored, Amazon S3 returns 200 OK in the response. Special Errors Code: RestoreAlreadyInProgress Cause: Object restore is already in progress. (This error does not apply to SELECT type requests.) HTTP Status Code: 409 Conflict SOAP Fault Code Prefix: Client Code: GlacierExpeditedRetrievalNotAvailable Cause: expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to S3 Standard or Bulk retrievals.) HTTP Status Code: 503 SOAP Fault Code Prefix: N/A Related Resources PutBucketLifecycleConfiguration GetBucketNotificationConfiguration SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon S3 User Guide
|
|
746
754
|
*/
|
|
747
755
|
restoreObject(params: S3.Types.RestoreObjectRequest, callback?: (err: AWSError, data: S3.Types.RestoreObjectOutput) => void): Request<S3.Types.RestoreObjectOutput, AWSError>;
|
|
748
756
|
/**
|
|
749
|
-
* Restores an archived copy of an object back into Amazon S3 This action is not supported by Amazon S3 on Outposts. This action performs the following types of requests: select - Perform a select query on an archived object restore an archive - Restore an archived object To use this operation, you must have permissions to perform the s3:RestoreObject action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide. Querying Archives with Select Requests You use a select type of request to perform SQL queries on archived objects. The archived objects that are being queried by the select request must be formatted as uncompressed comma-separated values (CSV) files. You can run queries and custom analytics on your archived data without having to restore your data to a hotter Amazon S3 tier. For an overview about select requests, see Querying Archived Objects in the Amazon S3 User Guide. When making a select request, do the following: Define an output location for the select query's output. This must be an Amazon S3 bucket in the same Amazon Web Services Region as the bucket that contains the archive object that is being queried. The Amazon Web Services account that initiates the job must have permissions to write to the S3 bucket. You can specify the storage class and encryption for the output objects stored in the bucket. For more information about output, see Querying Archived Objects in the Amazon S3 User Guide. For more information about the S3 structure in the request body, see the following: PutObject Managing Access with ACLs in the Amazon S3 User Guide Protecting Data Using Server-Side Encryption in the Amazon S3 User Guide Define the SQL expression for the SELECT type of restoration for your query in the request body's SelectParameters structure. You can use expressions like the following examples. The following expression returns all records from the specified object. SELECT * FROM Object Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers. SELECT s._1, s._2 FROM Object s WHERE s._3 > 100 If you have headers and you set the fileHeaderInfo in the CSV structure in the request body to USE, you can specify headers in the query. (If you set the fileHeaderInfo field to IGNORE, the first row is skipped for the query.) You cannot mix ordinal positions with header column names. SELECT s.Id, s.FirstName, s.SSN FROM S3Object s For more information about using SQL with S3 Glacier Select restore, see SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon S3 User Guide. When making a select request, you can also do the following: To expedite your queries, specify the Expedited tier. For more information about tiers, see "Restoring Archives," later in this topic. Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results. The following are additional important facts about the select feature: The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle policy. You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't deduplicate requests, so avoid issuing duplicate requests. Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response 409. Restoring objects Objects that you archive to the S3 Glacier or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time. For objects in Archive Access or Deep Archive Access tiers you must first initiate a restore request, and then wait until the object is moved into the Frequent Access tier. For objects in S3 Glacier or S3 Glacier Deep Archive storage classes you must first initiate a restore request, and then wait until a temporary copy of the object is available. To access an archived object, you must restore the object for the duration (number of days) that you specify. To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version. When restoring an archived object (or using a select request), you can specify one of the following data access tier options in the Tier element of the request body:
|
|
757
|
+
* Restores an archived copy of an object back into Amazon S3 This action is not supported by Amazon S3 on Outposts. This action performs the following types of requests: select - Perform a select query on an archived object restore an archive - Restore an archived object To use this operation, you must have permissions to perform the s3:RestoreObject action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide. Querying Archives with Select Requests You use a select type of request to perform SQL queries on archived objects. The archived objects that are being queried by the select request must be formatted as uncompressed comma-separated values (CSV) files. You can run queries and custom analytics on your archived data without having to restore your data to a hotter Amazon S3 tier. For an overview about select requests, see Querying Archived Objects in the Amazon S3 User Guide. When making a select request, do the following: Define an output location for the select query's output. This must be an Amazon S3 bucket in the same Amazon Web Services Region as the bucket that contains the archive object that is being queried. The Amazon Web Services account that initiates the job must have permissions to write to the S3 bucket. You can specify the storage class and encryption for the output objects stored in the bucket. For more information about output, see Querying Archived Objects in the Amazon S3 User Guide. For more information about the S3 structure in the request body, see the following: PutObject Managing Access with ACLs in the Amazon S3 User Guide Protecting Data Using Server-Side Encryption in the Amazon S3 User Guide Define the SQL expression for the SELECT type of restoration for your query in the request body's SelectParameters structure. You can use expressions like the following examples. The following expression returns all records from the specified object. SELECT * FROM Object Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers. SELECT s._1, s._2 FROM Object s WHERE s._3 > 100 If you have headers and you set the fileHeaderInfo in the CSV structure in the request body to USE, you can specify headers in the query. (If you set the fileHeaderInfo field to IGNORE, the first row is skipped for the query.) You cannot mix ordinal positions with header column names. SELECT s.Id, s.FirstName, s.SSN FROM S3Object s For more information about using SQL with S3 Glacier Select restore, see SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon S3 User Guide. When making a select request, you can also do the following: To expedite your queries, specify the Expedited tier. For more information about tiers, see "Restoring Archives," later in this topic. Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results. The following are additional important facts about the select feature: The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle policy. You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't deduplicate requests, so avoid issuing duplicate requests. Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response 409. Restoring objects Objects that you archive to the S3 Glacier or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time. For objects in Archive Access or Deep Archive Access tiers you must first initiate a restore request, and then wait until the object is moved into the Frequent Access tier. For objects in S3 Glacier or S3 Glacier Deep Archive storage classes you must first initiate a restore request, and then wait until a temporary copy of the object is available. To access an archived object, you must restore the object for the duration (number of days) that you specify. To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version. When restoring an archived object (or using a select request), you can specify one of the following data access tier options in the Tier element of the request body: Expedited - Expedited retrievals allow you to quickly access your data stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests for a subset of archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals is typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard - Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for retrieval requests that do not specify the retrieval option. Standard retrievals typically finish within 3–5 hours for objects stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in S3 Intelligent-Tiering. Bulk - Bulk retrievals are the lowest-cost retrieval option in S3 Glacier, enabling you to retrieve large amounts, even petabytes, of data inexpensively. Bulk retrievals typically finish within 5–12 hours for objects stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Bulk retrievals are free for objects stored in S3 Intelligent-Tiering. For more information about archive retrieval options and provisioned capacity for Expedited data access, see Restoring Archived Objects in the Amazon S3 User Guide. You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the Amazon S3 User Guide. To get the status of object restoration, you can send a HEAD request. Operations return the x-amz-restore header, which provides information about the restoration status, in the response. You can use Amazon S3 event notifications to notify you when a restore is initiated or completed. For more information, see Configuring Amazon S3 Event Notifications in the Amazon S3 User Guide. After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object. If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management in Amazon S3 User Guide. Responses A successful action returns either the 200 OK or 202 Accepted status code. If the object is not previously restored, then Amazon S3 returns 202 Accepted in the response. If the object is previously restored, Amazon S3 returns 200 OK in the response. Special Errors Code: RestoreAlreadyInProgress Cause: Object restore is already in progress. (This error does not apply to SELECT type requests.) HTTP Status Code: 409 Conflict SOAP Fault Code Prefix: Client Code: GlacierExpeditedRetrievalNotAvailable Cause: expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to S3 Standard or Bulk retrievals.) HTTP Status Code: 503 SOAP Fault Code Prefix: N/A Related Resources PutBucketLifecycleConfiguration GetBucketNotificationConfiguration SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon S3 User Guide
|
|
750
758
|
*/
|
|
751
759
|
restoreObject(callback?: (err: AWSError, data: S3.Types.RestoreObjectOutput) => void): Request<S3.Types.RestoreObjectOutput, AWSError>;
|
|
752
760
|
/**
|
|
@@ -758,19 +766,19 @@ declare class S3 extends S3Customizations {
|
|
|
758
766
|
*/
|
|
759
767
|
selectObjectContent(callback?: (err: AWSError, data: S3.Types.SelectObjectContentOutput) => void): Request<S3.Types.SelectObjectContentOutput, AWSError>;
|
|
760
768
|
/**
|
|
761
|
-
* Uploads a part in a multipart upload. In this operation, you provide part data in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the UploadPartCopy operation. You must initiate a multipart upload (see CreateMultipartUpload) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier, that you must include in your upload part request. Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten.
|
|
769
|
+
* Uploads a part in a multipart upload. In this operation, you provide part data in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the UploadPartCopy operation. You must initiate a multipart upload (see CreateMultipartUpload) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier, that you must include in your upload part request. Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten. For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide. To ensure that data is not corrupted when traversing the network, specify the Content-MD5 header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error. If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the x-amz-content-sha256 header as a checksum instead of Content-MD5. For more information see Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version 4). Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage. For more information on multipart uploads, go to Multipart Upload Overview in the Amazon S3 User Guide . For information on the permissions required to use the multipart upload API, go to Multipart Upload and Permissions in the Amazon S3 User Guide. You can optionally request server-side encryption where Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it for you when you access it. You have the option of providing your own encryption key, or you can use the Amazon Web Services managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in the request must match the headers you used in the request to initiate the upload by using CreateMultipartUpload. For more information, go to Using Server-Side Encryption in the Amazon S3 User Guide. Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are using a customer-provided encryption key, you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see CreateMultipartUpload. If you requested server-side encryption using a customer-provided encryption key in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following headers. x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 Special Errors Code: NoSuchUpload Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client Related Resources CreateMultipartUpload CompleteMultipartUpload AbortMultipartUpload ListParts ListMultipartUploads
|
|
762
770
|
*/
|
|
763
771
|
uploadPart(params: S3.Types.UploadPartRequest, callback?: (err: AWSError, data: S3.Types.UploadPartOutput) => void): Request<S3.Types.UploadPartOutput, AWSError>;
|
|
764
772
|
/**
|
|
765
|
-
* Uploads a part in a multipart upload. In this operation, you provide part data in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the UploadPartCopy operation. You must initiate a multipart upload (see CreateMultipartUpload) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier, that you must include in your upload part request. Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten.
|
|
773
|
+
* Uploads a part in a multipart upload. In this operation, you provide part data in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the UploadPartCopy operation. You must initiate a multipart upload (see CreateMultipartUpload) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier, that you must include in your upload part request. Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten. For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide. To ensure that data is not corrupted when traversing the network, specify the Content-MD5 header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error. If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the x-amz-content-sha256 header as a checksum instead of Content-MD5. For more information see Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version 4). Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage. For more information on multipart uploads, go to Multipart Upload Overview in the Amazon S3 User Guide . For information on the permissions required to use the multipart upload API, go to Multipart Upload and Permissions in the Amazon S3 User Guide. You can optionally request server-side encryption where Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it for you when you access it. You have the option of providing your own encryption key, or you can use the Amazon Web Services managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in the request must match the headers you used in the request to initiate the upload by using CreateMultipartUpload. For more information, go to Using Server-Side Encryption in the Amazon S3 User Guide. Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are using a customer-provided encryption key, you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see CreateMultipartUpload. If you requested server-side encryption using a customer-provided encryption key in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following headers. x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 Special Errors Code: NoSuchUpload Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client Related Resources CreateMultipartUpload CompleteMultipartUpload AbortMultipartUpload ListParts ListMultipartUploads
|
|
766
774
|
*/
|
|
767
775
|
uploadPart(callback?: (err: AWSError, data: S3.Types.UploadPartOutput) => void): Request<S3.Types.UploadPartOutput, AWSError>;
|
|
768
776
|
/**
|
|
769
|
-
* Uploads a part by copying data from an existing object as data source. You specify the data source by adding the request header x-amz-copy-source in your request and a byte range by adding the request header x-amz-copy-source-range in your request.
|
|
777
|
+
* Uploads a part by copying data from an existing object as data source. You specify the data source by adding the request header x-amz-copy-source in your request and a byte range by adding the request header x-amz-copy-source-range in your request. For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide. Instead of using an existing object as part data, you might use the UploadPart action and provide data in your request. You must initiate a multipart upload before you can upload any part. In response to your initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in your upload part request. For more information about using the UploadPartCopy operation, see the following: For conceptual information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide. For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide. For information about copying objects using a single atomic action vs. a multipart upload, see Operations on Objects in the Amazon S3 User Guide. For information about using server-side encryption with customer-provided encryption keys with the UploadPartCopy operation, see CopyObject and UploadPart. Note the following additional considerations about the request headers x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, x-amz-copy-source-if-unmodified-since, and x-amz-copy-source-if-modified-since: Consideration 1 - If both of the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request as follows: x-amz-copy-source-if-match condition evaluates to true, and; x-amz-copy-source-if-unmodified-since condition evaluates to false; Amazon S3 returns 200 OK and copies the data. Consideration 2 - If both of the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request as follows: x-amz-copy-source-if-none-match condition evaluates to false, and; x-amz-copy-source-if-modified-since condition evaluates to true; Amazon S3 returns 412 Precondition Failed response code. Versioning If your bucket has versioning enabled, you could have multiple versions of the same object. By default, x-amz-copy-source identifies the current version of the object to copy. If the current version is a delete marker and you don't specify a versionId in the x-amz-copy-source, Amazon S3 returns a 404 error, because the object does not exist. If you specify versionId in the x-amz-copy-source and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify a delete marker as a version for the x-amz-copy-source. You can optionally specify a specific version of the source object to copy by adding the versionId subresource as shown in the following example: x-amz-copy-source: /bucket/object?versionId=version id Special Errors Code: NoSuchUpload Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. HTTP Status Code: 404 Not Found Code: InvalidRequest Cause: The specified copy source is not supported as a byte-range copy source. HTTP Status Code: 400 Bad Request Related Resources CreateMultipartUpload UploadPart CompleteMultipartUpload AbortMultipartUpload ListParts ListMultipartUploads
|
|
770
778
|
*/
|
|
771
779
|
uploadPartCopy(params: S3.Types.UploadPartCopyRequest, callback?: (err: AWSError, data: S3.Types.UploadPartCopyOutput) => void): Request<S3.Types.UploadPartCopyOutput, AWSError>;
|
|
772
780
|
/**
|
|
773
|
-
* Uploads a part by copying data from an existing object as data source. You specify the data source by adding the request header x-amz-copy-source in your request and a byte range by adding the request header x-amz-copy-source-range in your request.
|
|
781
|
+
* Uploads a part by copying data from an existing object as data source. You specify the data source by adding the request header x-amz-copy-source in your request and a byte range by adding the request header x-amz-copy-source-range in your request. For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide. Instead of using an existing object as part data, you might use the UploadPart action and provide data in your request. You must initiate a multipart upload before you can upload any part. In response to your initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in your upload part request. For more information about using the UploadPartCopy operation, see the following: For conceptual information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide. For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide. For information about copying objects using a single atomic action vs. a multipart upload, see Operations on Objects in the Amazon S3 User Guide. For information about using server-side encryption with customer-provided encryption keys with the UploadPartCopy operation, see CopyObject and UploadPart. Note the following additional considerations about the request headers x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, x-amz-copy-source-if-unmodified-since, and x-amz-copy-source-if-modified-since: Consideration 1 - If both of the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request as follows: x-amz-copy-source-if-match condition evaluates to true, and; x-amz-copy-source-if-unmodified-since condition evaluates to false; Amazon S3 returns 200 OK and copies the data. Consideration 2 - If both of the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request as follows: x-amz-copy-source-if-none-match condition evaluates to false, and; x-amz-copy-source-if-modified-since condition evaluates to true; Amazon S3 returns 412 Precondition Failed response code. Versioning If your bucket has versioning enabled, you could have multiple versions of the same object. By default, x-amz-copy-source identifies the current version of the object to copy. If the current version is a delete marker and you don't specify a versionId in the x-amz-copy-source, Amazon S3 returns a 404 error, because the object does not exist. If you specify versionId in the x-amz-copy-source and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify a delete marker as a version for the x-amz-copy-source. You can optionally specify a specific version of the source object to copy by adding the versionId subresource as shown in the following example: x-amz-copy-source: /bucket/object?versionId=version id Special Errors Code: NoSuchUpload Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. HTTP Status Code: 404 Not Found Code: InvalidRequest Cause: The specified copy source is not supported as a byte-range copy source. HTTP Status Code: 400 Bad Request Related Resources CreateMultipartUpload UploadPart CompleteMultipartUpload AbortMultipartUpload ListParts ListMultipartUploads
|
|
774
782
|
*/
|
|
775
783
|
uploadPartCopy(callback?: (err: AWSError, data: S3.Types.UploadPartCopyOutput) => void): Request<S3.Types.UploadPartCopyOutput, AWSError>;
|
|
776
784
|
/**
|
|
@@ -831,7 +839,7 @@ declare namespace S3 {
|
|
|
831
839
|
}
|
|
832
840
|
export interface AbortMultipartUploadRequest {
|
|
833
841
|
/**
|
|
834
|
-
* The bucket name to which the upload was taking place. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
842
|
+
* The bucket name to which the upload was taking place. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
835
843
|
*/
|
|
836
844
|
Bucket: BucketName;
|
|
837
845
|
/**
|
|
@@ -844,7 +852,7 @@ declare namespace S3 {
|
|
|
844
852
|
UploadId: MultipartUploadId;
|
|
845
853
|
RequestPayer?: RequestPayer;
|
|
846
854
|
/**
|
|
847
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
855
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
848
856
|
*/
|
|
849
857
|
ExpectedBucketOwner?: AccountId;
|
|
850
858
|
}
|
|
@@ -1065,6 +1073,31 @@ declare namespace S3 {
|
|
|
1065
1073
|
QuoteCharacter?: QuoteCharacter;
|
|
1066
1074
|
}
|
|
1067
1075
|
export type CacheControl = string;
|
|
1076
|
+
export interface Checksum {
|
|
1077
|
+
/**
|
|
1078
|
+
* The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
1079
|
+
*/
|
|
1080
|
+
ChecksumCRC32?: ChecksumCRC32;
|
|
1081
|
+
/**
|
|
1082
|
+
* The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
1083
|
+
*/
|
|
1084
|
+
ChecksumCRC32C?: ChecksumCRC32C;
|
|
1085
|
+
/**
|
|
1086
|
+
* The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
1087
|
+
*/
|
|
1088
|
+
ChecksumSHA1?: ChecksumSHA1;
|
|
1089
|
+
/**
|
|
1090
|
+
* The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
1091
|
+
*/
|
|
1092
|
+
ChecksumSHA256?: ChecksumSHA256;
|
|
1093
|
+
}
|
|
1094
|
+
export type ChecksumAlgorithm = "CRC32"|"CRC32C"|"SHA1"|"SHA256"|string;
|
|
1095
|
+
export type ChecksumAlgorithmList = ChecksumAlgorithm[];
|
|
1096
|
+
export type ChecksumCRC32 = string;
|
|
1097
|
+
export type ChecksumCRC32C = string;
|
|
1098
|
+
export type ChecksumMode = "ENABLED"|string;
|
|
1099
|
+
export type ChecksumSHA1 = string;
|
|
1100
|
+
export type ChecksumSHA256 = string;
|
|
1068
1101
|
export type CloudFunction = string;
|
|
1069
1102
|
export interface CloudFunctionConfiguration {
|
|
1070
1103
|
Id?: NotificationId;
|
|
@@ -1098,7 +1131,7 @@ declare namespace S3 {
|
|
|
1098
1131
|
*/
|
|
1099
1132
|
Location?: Location;
|
|
1100
1133
|
/**
|
|
1101
|
-
* The name of the bucket that contains the newly created object. Does not return the access point ARN or access point alias if used. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
1134
|
+
* The name of the bucket that contains the newly created object. Does not return the access point ARN or access point alias if used. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
1102
1135
|
*/
|
|
1103
1136
|
Bucket?: BucketName;
|
|
1104
1137
|
/**
|
|
@@ -1106,13 +1139,29 @@ declare namespace S3 {
|
|
|
1106
1139
|
*/
|
|
1107
1140
|
Key?: ObjectKey;
|
|
1108
1141
|
/**
|
|
1109
|
-
* If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL
|
|
1142
|
+
* If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL-encoded.
|
|
1110
1143
|
*/
|
|
1111
1144
|
Expiration?: Expiration;
|
|
1112
1145
|
/**
|
|
1113
|
-
* Entity tag that identifies the newly created object's data. Objects with different object data will have different entity tags. The entity tag is an opaque string. The entity tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5 digest of the object data, it will contain one or more nonhexadecimal characters and/or will consist of less than 32 or more than 32 hexadecimal digits.
|
|
1146
|
+
* Entity tag that identifies the newly created object's data. Objects with different object data will have different entity tags. The entity tag is an opaque string. The entity tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5 digest of the object data, it will contain one or more nonhexadecimal characters and/or will consist of less than 32 or more than 32 hexadecimal digits. For more information about how the entity tag is calculated, see Checking object integrity in the Amazon S3 User Guide.
|
|
1114
1147
|
*/
|
|
1115
1148
|
ETag?: ETag;
|
|
1149
|
+
/**
|
|
1150
|
+
* The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
1151
|
+
*/
|
|
1152
|
+
ChecksumCRC32?: ChecksumCRC32;
|
|
1153
|
+
/**
|
|
1154
|
+
* The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
1155
|
+
*/
|
|
1156
|
+
ChecksumCRC32C?: ChecksumCRC32C;
|
|
1157
|
+
/**
|
|
1158
|
+
* The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
1159
|
+
*/
|
|
1160
|
+
ChecksumSHA1?: ChecksumSHA1;
|
|
1161
|
+
/**
|
|
1162
|
+
* The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
1163
|
+
*/
|
|
1164
|
+
ChecksumSHA256?: ChecksumSHA256;
|
|
1116
1165
|
/**
|
|
1117
1166
|
* If you specified server-side encryption either with an Amazon S3-managed encryption key or an Amazon Web Services KMS key in your initiate multipart upload request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.
|
|
1118
1167
|
*/
|
|
@@ -1133,7 +1182,7 @@ declare namespace S3 {
|
|
|
1133
1182
|
}
|
|
1134
1183
|
export interface CompleteMultipartUploadRequest {
|
|
1135
1184
|
/**
|
|
1136
|
-
* Name of the bucket to which the multipart upload was initiated. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
1185
|
+
* Name of the bucket to which the multipart upload was initiated. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
1137
1186
|
*/
|
|
1138
1187
|
Bucket: BucketName;
|
|
1139
1188
|
/**
|
|
@@ -1148,11 +1197,39 @@ declare namespace S3 {
|
|
|
1148
1197
|
* ID for the initiated multipart upload.
|
|
1149
1198
|
*/
|
|
1150
1199
|
UploadId: MultipartUploadId;
|
|
1200
|
+
/**
|
|
1201
|
+
* This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
|
|
1202
|
+
*/
|
|
1203
|
+
ChecksumCRC32?: ChecksumCRC32;
|
|
1204
|
+
/**
|
|
1205
|
+
* This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
|
|
1206
|
+
*/
|
|
1207
|
+
ChecksumCRC32C?: ChecksumCRC32C;
|
|
1208
|
+
/**
|
|
1209
|
+
* This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
|
|
1210
|
+
*/
|
|
1211
|
+
ChecksumSHA1?: ChecksumSHA1;
|
|
1212
|
+
/**
|
|
1213
|
+
* This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
|
|
1214
|
+
*/
|
|
1215
|
+
ChecksumSHA256?: ChecksumSHA256;
|
|
1151
1216
|
RequestPayer?: RequestPayer;
|
|
1152
1217
|
/**
|
|
1153
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
1218
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
1154
1219
|
*/
|
|
1155
1220
|
ExpectedBucketOwner?: AccountId;
|
|
1221
|
+
/**
|
|
1222
|
+
* The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
|
|
1223
|
+
*/
|
|
1224
|
+
SSECustomerAlgorithm?: SSECustomerAlgorithm;
|
|
1225
|
+
/**
|
|
1226
|
+
* The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
|
|
1227
|
+
*/
|
|
1228
|
+
SSECustomerKey?: SSECustomerKey;
|
|
1229
|
+
/**
|
|
1230
|
+
* The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
|
|
1231
|
+
*/
|
|
1232
|
+
SSECustomerKeyMD5?: SSECustomerKeyMD5;
|
|
1156
1233
|
}
|
|
1157
1234
|
export interface CompletedMultipartUpload {
|
|
1158
1235
|
/**
|
|
@@ -1165,6 +1242,22 @@ declare namespace S3 {
|
|
|
1165
1242
|
* Entity tag returned when the part was uploaded.
|
|
1166
1243
|
*/
|
|
1167
1244
|
ETag?: ETag;
|
|
1245
|
+
/**
|
|
1246
|
+
* The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
1247
|
+
*/
|
|
1248
|
+
ChecksumCRC32?: ChecksumCRC32;
|
|
1249
|
+
/**
|
|
1250
|
+
* The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
1251
|
+
*/
|
|
1252
|
+
ChecksumCRC32C?: ChecksumCRC32C;
|
|
1253
|
+
/**
|
|
1254
|
+
* The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
1255
|
+
*/
|
|
1256
|
+
ChecksumSHA1?: ChecksumSHA1;
|
|
1257
|
+
/**
|
|
1258
|
+
* The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
1259
|
+
*/
|
|
1260
|
+
ChecksumSHA256?: ChecksumSHA256;
|
|
1168
1261
|
/**
|
|
1169
1262
|
* Part number that identifies the part. This is a positive integer between 1 and 10,000.
|
|
1170
1263
|
*/
|
|
@@ -1241,13 +1334,17 @@ declare namespace S3 {
|
|
|
1241
1334
|
*/
|
|
1242
1335
|
ACL?: ObjectCannedACL;
|
|
1243
1336
|
/**
|
|
1244
|
-
* The name of the destination bucket. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
1337
|
+
* The name of the destination bucket. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
1245
1338
|
*/
|
|
1246
1339
|
Bucket: BucketName;
|
|
1247
1340
|
/**
|
|
1248
1341
|
* Specifies caching behavior along the request/reply chain.
|
|
1249
1342
|
*/
|
|
1250
1343
|
CacheControl?: CacheControl;
|
|
1344
|
+
/**
|
|
1345
|
+
* Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
|
|
1346
|
+
*/
|
|
1347
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
1251
1348
|
/**
|
|
1252
1349
|
* Specifies presentational information for the object.
|
|
1253
1350
|
*/
|
|
@@ -1265,7 +1362,7 @@ declare namespace S3 {
|
|
|
1265
1362
|
*/
|
|
1266
1363
|
ContentType?: ContentType;
|
|
1267
1364
|
/**
|
|
1268
|
-
* Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point: For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL
|
|
1365
|
+
* Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point: For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL-encoded. For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded. Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region. Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL-encoded. To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.
|
|
1269
1366
|
*/
|
|
1270
1367
|
CopySource: CopySource;
|
|
1271
1368
|
/**
|
|
@@ -1382,15 +1479,15 @@ declare namespace S3 {
|
|
|
1382
1479
|
*/
|
|
1383
1480
|
ObjectLockRetainUntilDate?: ObjectLockRetainUntilDate;
|
|
1384
1481
|
/**
|
|
1385
|
-
* Specifies whether you want to apply a
|
|
1482
|
+
* Specifies whether you want to apply a legal hold to the copied object.
|
|
1386
1483
|
*/
|
|
1387
1484
|
ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus;
|
|
1388
1485
|
/**
|
|
1389
|
-
* The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request
|
|
1486
|
+
* The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
1390
1487
|
*/
|
|
1391
1488
|
ExpectedBucketOwner?: AccountId;
|
|
1392
1489
|
/**
|
|
1393
|
-
* The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request
|
|
1490
|
+
* The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
1394
1491
|
*/
|
|
1395
1492
|
ExpectedSourceBucketOwner?: AccountId;
|
|
1396
1493
|
}
|
|
@@ -1403,6 +1500,22 @@ declare namespace S3 {
|
|
|
1403
1500
|
* Creation date of the object.
|
|
1404
1501
|
*/
|
|
1405
1502
|
LastModified?: LastModified;
|
|
1503
|
+
/**
|
|
1504
|
+
* The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
1505
|
+
*/
|
|
1506
|
+
ChecksumCRC32?: ChecksumCRC32;
|
|
1507
|
+
/**
|
|
1508
|
+
* The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
1509
|
+
*/
|
|
1510
|
+
ChecksumCRC32C?: ChecksumCRC32C;
|
|
1511
|
+
/**
|
|
1512
|
+
* The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
1513
|
+
*/
|
|
1514
|
+
ChecksumSHA1?: ChecksumSHA1;
|
|
1515
|
+
/**
|
|
1516
|
+
* The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
1517
|
+
*/
|
|
1518
|
+
ChecksumSHA256?: ChecksumSHA256;
|
|
1406
1519
|
}
|
|
1407
1520
|
export interface CopyPartResult {
|
|
1408
1521
|
/**
|
|
@@ -1413,6 +1526,22 @@ declare namespace S3 {
|
|
|
1413
1526
|
* Date and time at which the object was uploaded.
|
|
1414
1527
|
*/
|
|
1415
1528
|
LastModified?: LastModified;
|
|
1529
|
+
/**
|
|
1530
|
+
* The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
1531
|
+
*/
|
|
1532
|
+
ChecksumCRC32?: ChecksumCRC32;
|
|
1533
|
+
/**
|
|
1534
|
+
* The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
1535
|
+
*/
|
|
1536
|
+
ChecksumCRC32C?: ChecksumCRC32C;
|
|
1537
|
+
/**
|
|
1538
|
+
* The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
1539
|
+
*/
|
|
1540
|
+
ChecksumSHA1?: ChecksumSHA1;
|
|
1541
|
+
/**
|
|
1542
|
+
* The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
1543
|
+
*/
|
|
1544
|
+
ChecksumSHA256?: ChecksumSHA256;
|
|
1416
1545
|
}
|
|
1417
1546
|
export type CopySource = string;
|
|
1418
1547
|
export type CopySourceIfMatch = string;
|
|
@@ -1432,7 +1561,7 @@ declare namespace S3 {
|
|
|
1432
1561
|
}
|
|
1433
1562
|
export interface CreateBucketOutput {
|
|
1434
1563
|
/**
|
|
1435
|
-
*
|
|
1564
|
+
* A forward slash followed by the name of the bucket.
|
|
1436
1565
|
*/
|
|
1437
1566
|
Location?: Location;
|
|
1438
1567
|
}
|
|
@@ -1485,7 +1614,7 @@ declare namespace S3 {
|
|
|
1485
1614
|
*/
|
|
1486
1615
|
AbortRuleId?: AbortRuleId;
|
|
1487
1616
|
/**
|
|
1488
|
-
* The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
1617
|
+
* The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
1489
1618
|
*/
|
|
1490
1619
|
Bucket?: BucketName;
|
|
1491
1620
|
/**
|
|
@@ -1521,6 +1650,10 @@ declare namespace S3 {
|
|
|
1521
1650
|
*/
|
|
1522
1651
|
BucketKeyEnabled?: BucketKeyEnabled;
|
|
1523
1652
|
RequestCharged?: RequestCharged;
|
|
1653
|
+
/**
|
|
1654
|
+
* The algorithm that was used to create a checksum of the object.
|
|
1655
|
+
*/
|
|
1656
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
1524
1657
|
}
|
|
1525
1658
|
export interface CreateMultipartUploadRequest {
|
|
1526
1659
|
/**
|
|
@@ -1528,7 +1661,7 @@ declare namespace S3 {
|
|
|
1528
1661
|
*/
|
|
1529
1662
|
ACL?: ObjectCannedACL;
|
|
1530
1663
|
/**
|
|
1531
|
-
* The name of the bucket to which to initiate the upload When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
1664
|
+
* The name of the bucket to which to initiate the upload When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
1532
1665
|
*/
|
|
1533
1666
|
Bucket: BucketName;
|
|
1534
1667
|
/**
|
|
@@ -1629,13 +1762,17 @@ declare namespace S3 {
|
|
|
1629
1762
|
*/
|
|
1630
1763
|
ObjectLockRetainUntilDate?: ObjectLockRetainUntilDate;
|
|
1631
1764
|
/**
|
|
1632
|
-
* Specifies whether you want to apply a
|
|
1765
|
+
* Specifies whether you want to apply a legal hold to the uploaded object.
|
|
1633
1766
|
*/
|
|
1634
1767
|
ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus;
|
|
1635
1768
|
/**
|
|
1636
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
1769
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
1637
1770
|
*/
|
|
1638
1771
|
ExpectedBucketOwner?: AccountId;
|
|
1772
|
+
/**
|
|
1773
|
+
* Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
|
|
1774
|
+
*/
|
|
1775
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
1639
1776
|
}
|
|
1640
1777
|
export type CreationDate = Date;
|
|
1641
1778
|
export type _Date = Date;
|
|
@@ -1675,7 +1812,7 @@ declare namespace S3 {
|
|
|
1675
1812
|
*/
|
|
1676
1813
|
Id: AnalyticsId;
|
|
1677
1814
|
/**
|
|
1678
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
1815
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
1679
1816
|
*/
|
|
1680
1817
|
ExpectedBucketOwner?: AccountId;
|
|
1681
1818
|
}
|
|
@@ -1685,7 +1822,7 @@ declare namespace S3 {
|
|
|
1685
1822
|
*/
|
|
1686
1823
|
Bucket: BucketName;
|
|
1687
1824
|
/**
|
|
1688
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
1825
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
1689
1826
|
*/
|
|
1690
1827
|
ExpectedBucketOwner?: AccountId;
|
|
1691
1828
|
}
|
|
@@ -1695,7 +1832,7 @@ declare namespace S3 {
|
|
|
1695
1832
|
*/
|
|
1696
1833
|
Bucket: BucketName;
|
|
1697
1834
|
/**
|
|
1698
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
1835
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
1699
1836
|
*/
|
|
1700
1837
|
ExpectedBucketOwner?: AccountId;
|
|
1701
1838
|
}
|
|
@@ -1719,7 +1856,7 @@ declare namespace S3 {
|
|
|
1719
1856
|
*/
|
|
1720
1857
|
Id: InventoryId;
|
|
1721
1858
|
/**
|
|
1722
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
1859
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
1723
1860
|
*/
|
|
1724
1861
|
ExpectedBucketOwner?: AccountId;
|
|
1725
1862
|
}
|
|
@@ -1729,7 +1866,7 @@ declare namespace S3 {
|
|
|
1729
1866
|
*/
|
|
1730
1867
|
Bucket: BucketName;
|
|
1731
1868
|
/**
|
|
1732
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
1869
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
1733
1870
|
*/
|
|
1734
1871
|
ExpectedBucketOwner?: AccountId;
|
|
1735
1872
|
}
|
|
@@ -1743,7 +1880,7 @@ declare namespace S3 {
|
|
|
1743
1880
|
*/
|
|
1744
1881
|
Id: MetricsId;
|
|
1745
1882
|
/**
|
|
1746
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
1883
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
1747
1884
|
*/
|
|
1748
1885
|
ExpectedBucketOwner?: AccountId;
|
|
1749
1886
|
}
|
|
@@ -1753,7 +1890,7 @@ declare namespace S3 {
|
|
|
1753
1890
|
*/
|
|
1754
1891
|
Bucket: BucketName;
|
|
1755
1892
|
/**
|
|
1756
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
1893
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
1757
1894
|
*/
|
|
1758
1895
|
ExpectedBucketOwner?: AccountId;
|
|
1759
1896
|
}
|
|
@@ -1763,7 +1900,7 @@ declare namespace S3 {
|
|
|
1763
1900
|
*/
|
|
1764
1901
|
Bucket: BucketName;
|
|
1765
1902
|
/**
|
|
1766
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
1903
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
1767
1904
|
*/
|
|
1768
1905
|
ExpectedBucketOwner?: AccountId;
|
|
1769
1906
|
}
|
|
@@ -1773,7 +1910,7 @@ declare namespace S3 {
|
|
|
1773
1910
|
*/
|
|
1774
1911
|
Bucket: BucketName;
|
|
1775
1912
|
/**
|
|
1776
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
1913
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
1777
1914
|
*/
|
|
1778
1915
|
ExpectedBucketOwner?: AccountId;
|
|
1779
1916
|
}
|
|
@@ -1783,7 +1920,7 @@ declare namespace S3 {
|
|
|
1783
1920
|
*/
|
|
1784
1921
|
Bucket: BucketName;
|
|
1785
1922
|
/**
|
|
1786
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
1923
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
1787
1924
|
*/
|
|
1788
1925
|
ExpectedBucketOwner?: AccountId;
|
|
1789
1926
|
}
|
|
@@ -1793,7 +1930,7 @@ declare namespace S3 {
|
|
|
1793
1930
|
*/
|
|
1794
1931
|
Bucket: BucketName;
|
|
1795
1932
|
/**
|
|
1796
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
1933
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
1797
1934
|
*/
|
|
1798
1935
|
ExpectedBucketOwner?: AccountId;
|
|
1799
1936
|
}
|
|
@@ -1803,7 +1940,7 @@ declare namespace S3 {
|
|
|
1803
1940
|
*/
|
|
1804
1941
|
Bucket: BucketName;
|
|
1805
1942
|
/**
|
|
1806
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
1943
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
1807
1944
|
*/
|
|
1808
1945
|
ExpectedBucketOwner?: AccountId;
|
|
1809
1946
|
}
|
|
@@ -1852,7 +1989,7 @@ declare namespace S3 {
|
|
|
1852
1989
|
}
|
|
1853
1990
|
export interface DeleteObjectRequest {
|
|
1854
1991
|
/**
|
|
1855
|
-
* The bucket name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
1992
|
+
* The bucket name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
1856
1993
|
*/
|
|
1857
1994
|
Bucket: BucketName;
|
|
1858
1995
|
/**
|
|
@@ -1869,11 +2006,11 @@ declare namespace S3 {
|
|
|
1869
2006
|
VersionId?: ObjectVersionId;
|
|
1870
2007
|
RequestPayer?: RequestPayer;
|
|
1871
2008
|
/**
|
|
1872
|
-
* Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the s3:
|
|
2009
|
+
* Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the s3:BypassGovernanceRetention permission.
|
|
1873
2010
|
*/
|
|
1874
2011
|
BypassGovernanceRetention?: BypassGovernanceRetention;
|
|
1875
2012
|
/**
|
|
1876
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2013
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
1877
2014
|
*/
|
|
1878
2015
|
ExpectedBucketOwner?: AccountId;
|
|
1879
2016
|
}
|
|
@@ -1885,7 +2022,7 @@ declare namespace S3 {
|
|
|
1885
2022
|
}
|
|
1886
2023
|
export interface DeleteObjectTaggingRequest {
|
|
1887
2024
|
/**
|
|
1888
|
-
* The bucket name containing the objects from which to remove the tags. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
2025
|
+
* The bucket name containing the objects from which to remove the tags. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
1889
2026
|
*/
|
|
1890
2027
|
Bucket: BucketName;
|
|
1891
2028
|
/**
|
|
@@ -1897,7 +2034,7 @@ declare namespace S3 {
|
|
|
1897
2034
|
*/
|
|
1898
2035
|
VersionId?: ObjectVersionId;
|
|
1899
2036
|
/**
|
|
1900
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2037
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
1901
2038
|
*/
|
|
1902
2039
|
ExpectedBucketOwner?: AccountId;
|
|
1903
2040
|
}
|
|
@@ -1914,7 +2051,7 @@ declare namespace S3 {
|
|
|
1914
2051
|
}
|
|
1915
2052
|
export interface DeleteObjectsRequest {
|
|
1916
2053
|
/**
|
|
1917
|
-
* The bucket name containing the objects to delete. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
2054
|
+
* The bucket name containing the objects to delete. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
1918
2055
|
*/
|
|
1919
2056
|
Bucket: BucketName;
|
|
1920
2057
|
/**
|
|
@@ -1927,13 +2064,17 @@ declare namespace S3 {
|
|
|
1927
2064
|
MFA?: MFA;
|
|
1928
2065
|
RequestPayer?: RequestPayer;
|
|
1929
2066
|
/**
|
|
1930
|
-
* Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. To use this header, you must have the s3:
|
|
2067
|
+
* Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. To use this header, you must have the s3:BypassGovernanceRetention permission.
|
|
1931
2068
|
*/
|
|
1932
2069
|
BypassGovernanceRetention?: BypassGovernanceRetention;
|
|
1933
2070
|
/**
|
|
1934
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2071
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
1935
2072
|
*/
|
|
1936
2073
|
ExpectedBucketOwner?: AccountId;
|
|
2074
|
+
/**
|
|
2075
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter. This checksum algorithm must be the same for all parts and it match the checksum value supplied in the CreateMultipartUpload request.
|
|
2076
|
+
*/
|
|
2077
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
1937
2078
|
}
|
|
1938
2079
|
export interface DeletePublicAccessBlockRequest {
|
|
1939
2080
|
/**
|
|
@@ -1941,7 +2082,7 @@ declare namespace S3 {
|
|
|
1941
2082
|
*/
|
|
1942
2083
|
Bucket: BucketName;
|
|
1943
2084
|
/**
|
|
1944
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2085
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
1945
2086
|
*/
|
|
1946
2087
|
ExpectedBucketOwner?: AccountId;
|
|
1947
2088
|
}
|
|
@@ -2098,7 +2239,7 @@ declare namespace S3 {
|
|
|
2098
2239
|
*/
|
|
2099
2240
|
Bucket: BucketName;
|
|
2100
2241
|
/**
|
|
2101
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2242
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2102
2243
|
*/
|
|
2103
2244
|
ExpectedBucketOwner?: AccountId;
|
|
2104
2245
|
}
|
|
@@ -2118,7 +2259,7 @@ declare namespace S3 {
|
|
|
2118
2259
|
*/
|
|
2119
2260
|
Bucket: BucketName;
|
|
2120
2261
|
/**
|
|
2121
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2262
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2122
2263
|
*/
|
|
2123
2264
|
ExpectedBucketOwner?: AccountId;
|
|
2124
2265
|
}
|
|
@@ -2138,7 +2279,7 @@ declare namespace S3 {
|
|
|
2138
2279
|
*/
|
|
2139
2280
|
Id: AnalyticsId;
|
|
2140
2281
|
/**
|
|
2141
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2282
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2142
2283
|
*/
|
|
2143
2284
|
ExpectedBucketOwner?: AccountId;
|
|
2144
2285
|
}
|
|
@@ -2154,7 +2295,7 @@ declare namespace S3 {
|
|
|
2154
2295
|
*/
|
|
2155
2296
|
Bucket: BucketName;
|
|
2156
2297
|
/**
|
|
2157
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2298
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2158
2299
|
*/
|
|
2159
2300
|
ExpectedBucketOwner?: AccountId;
|
|
2160
2301
|
}
|
|
@@ -2167,7 +2308,7 @@ declare namespace S3 {
|
|
|
2167
2308
|
*/
|
|
2168
2309
|
Bucket: BucketName;
|
|
2169
2310
|
/**
|
|
2170
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2311
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2171
2312
|
*/
|
|
2172
2313
|
ExpectedBucketOwner?: AccountId;
|
|
2173
2314
|
}
|
|
@@ -2203,7 +2344,7 @@ declare namespace S3 {
|
|
|
2203
2344
|
*/
|
|
2204
2345
|
Id: InventoryId;
|
|
2205
2346
|
/**
|
|
2206
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2347
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2207
2348
|
*/
|
|
2208
2349
|
ExpectedBucketOwner?: AccountId;
|
|
2209
2350
|
}
|
|
@@ -2219,7 +2360,7 @@ declare namespace S3 {
|
|
|
2219
2360
|
*/
|
|
2220
2361
|
Bucket: BucketName;
|
|
2221
2362
|
/**
|
|
2222
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2363
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2223
2364
|
*/
|
|
2224
2365
|
ExpectedBucketOwner?: AccountId;
|
|
2225
2366
|
}
|
|
@@ -2235,7 +2376,7 @@ declare namespace S3 {
|
|
|
2235
2376
|
*/
|
|
2236
2377
|
Bucket: BucketName;
|
|
2237
2378
|
/**
|
|
2238
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2379
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2239
2380
|
*/
|
|
2240
2381
|
ExpectedBucketOwner?: AccountId;
|
|
2241
2382
|
}
|
|
@@ -2251,7 +2392,7 @@ declare namespace S3 {
|
|
|
2251
2392
|
*/
|
|
2252
2393
|
Bucket: BucketName;
|
|
2253
2394
|
/**
|
|
2254
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2395
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2255
2396
|
*/
|
|
2256
2397
|
ExpectedBucketOwner?: AccountId;
|
|
2257
2398
|
}
|
|
@@ -2264,7 +2405,7 @@ declare namespace S3 {
|
|
|
2264
2405
|
*/
|
|
2265
2406
|
Bucket: BucketName;
|
|
2266
2407
|
/**
|
|
2267
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2408
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2268
2409
|
*/
|
|
2269
2410
|
ExpectedBucketOwner?: AccountId;
|
|
2270
2411
|
}
|
|
@@ -2284,7 +2425,7 @@ declare namespace S3 {
|
|
|
2284
2425
|
*/
|
|
2285
2426
|
Id: MetricsId;
|
|
2286
2427
|
/**
|
|
2287
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2428
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2288
2429
|
*/
|
|
2289
2430
|
ExpectedBucketOwner?: AccountId;
|
|
2290
2431
|
}
|
|
@@ -2294,7 +2435,7 @@ declare namespace S3 {
|
|
|
2294
2435
|
*/
|
|
2295
2436
|
Bucket: BucketName;
|
|
2296
2437
|
/**
|
|
2297
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2438
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2298
2439
|
*/
|
|
2299
2440
|
ExpectedBucketOwner?: AccountId;
|
|
2300
2441
|
}
|
|
@@ -2310,7 +2451,7 @@ declare namespace S3 {
|
|
|
2310
2451
|
*/
|
|
2311
2452
|
Bucket: BucketName;
|
|
2312
2453
|
/**
|
|
2313
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2454
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2314
2455
|
*/
|
|
2315
2456
|
ExpectedBucketOwner?: AccountId;
|
|
2316
2457
|
}
|
|
@@ -2326,7 +2467,7 @@ declare namespace S3 {
|
|
|
2326
2467
|
*/
|
|
2327
2468
|
Bucket: BucketName;
|
|
2328
2469
|
/**
|
|
2329
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2470
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2330
2471
|
*/
|
|
2331
2472
|
ExpectedBucketOwner?: AccountId;
|
|
2332
2473
|
}
|
|
@@ -2342,7 +2483,7 @@ declare namespace S3 {
|
|
|
2342
2483
|
*/
|
|
2343
2484
|
Bucket: BucketName;
|
|
2344
2485
|
/**
|
|
2345
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2486
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2346
2487
|
*/
|
|
2347
2488
|
ExpectedBucketOwner?: AccountId;
|
|
2348
2489
|
}
|
|
@@ -2355,7 +2496,7 @@ declare namespace S3 {
|
|
|
2355
2496
|
*/
|
|
2356
2497
|
Bucket: BucketName;
|
|
2357
2498
|
/**
|
|
2358
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2499
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2359
2500
|
*/
|
|
2360
2501
|
ExpectedBucketOwner?: AccountId;
|
|
2361
2502
|
}
|
|
@@ -2371,7 +2512,7 @@ declare namespace S3 {
|
|
|
2371
2512
|
*/
|
|
2372
2513
|
Bucket: BucketName;
|
|
2373
2514
|
/**
|
|
2374
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2515
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2375
2516
|
*/
|
|
2376
2517
|
ExpectedBucketOwner?: AccountId;
|
|
2377
2518
|
}
|
|
@@ -2387,7 +2528,7 @@ declare namespace S3 {
|
|
|
2387
2528
|
*/
|
|
2388
2529
|
Bucket: BucketName;
|
|
2389
2530
|
/**
|
|
2390
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2531
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2391
2532
|
*/
|
|
2392
2533
|
ExpectedBucketOwner?: AccountId;
|
|
2393
2534
|
}
|
|
@@ -2407,7 +2548,7 @@ declare namespace S3 {
|
|
|
2407
2548
|
*/
|
|
2408
2549
|
Bucket: BucketName;
|
|
2409
2550
|
/**
|
|
2410
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2551
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2411
2552
|
*/
|
|
2412
2553
|
ExpectedBucketOwner?: AccountId;
|
|
2413
2554
|
}
|
|
@@ -2435,7 +2576,7 @@ declare namespace S3 {
|
|
|
2435
2576
|
*/
|
|
2436
2577
|
Bucket: BucketName;
|
|
2437
2578
|
/**
|
|
2438
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2579
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2439
2580
|
*/
|
|
2440
2581
|
ExpectedBucketOwner?: AccountId;
|
|
2441
2582
|
}
|
|
@@ -2465,32 +2606,136 @@ declare namespace S3 {
|
|
|
2465
2606
|
VersionId?: ObjectVersionId;
|
|
2466
2607
|
RequestPayer?: RequestPayer;
|
|
2467
2608
|
/**
|
|
2468
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2609
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2469
2610
|
*/
|
|
2470
2611
|
ExpectedBucketOwner?: AccountId;
|
|
2471
2612
|
}
|
|
2613
|
+
export interface GetObjectAttributesOutput {
|
|
2614
|
+
/**
|
|
2615
|
+
* Specifies whether the object retrieved was (true) or was not (false) a delete marker. If false, this response header does not appear in the response.
|
|
2616
|
+
*/
|
|
2617
|
+
DeleteMarker?: DeleteMarker;
|
|
2618
|
+
/**
|
|
2619
|
+
* The creation date of the object.
|
|
2620
|
+
*/
|
|
2621
|
+
LastModified?: LastModified;
|
|
2622
|
+
/**
|
|
2623
|
+
* The version ID of the object.
|
|
2624
|
+
*/
|
|
2625
|
+
VersionId?: ObjectVersionId;
|
|
2626
|
+
RequestCharged?: RequestCharged;
|
|
2627
|
+
/**
|
|
2628
|
+
* An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
|
|
2629
|
+
*/
|
|
2630
|
+
ETag?: ETag;
|
|
2631
|
+
/**
|
|
2632
|
+
* The checksum or digest of the object.
|
|
2633
|
+
*/
|
|
2634
|
+
Checksum?: Checksum;
|
|
2635
|
+
/**
|
|
2636
|
+
* A collection of parts associated with a multipart upload.
|
|
2637
|
+
*/
|
|
2638
|
+
ObjectParts?: GetObjectAttributesParts;
|
|
2639
|
+
/**
|
|
2640
|
+
* Provides the storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects. For more information, see Storage Classes.
|
|
2641
|
+
*/
|
|
2642
|
+
StorageClass?: StorageClass;
|
|
2643
|
+
/**
|
|
2644
|
+
* The size of the object in bytes.
|
|
2645
|
+
*/
|
|
2646
|
+
ObjectSize?: ObjectSize;
|
|
2647
|
+
}
|
|
2648
|
+
export interface GetObjectAttributesParts {
|
|
2649
|
+
/**
|
|
2650
|
+
* The total number of parts.
|
|
2651
|
+
*/
|
|
2652
|
+
TotalPartsCount?: PartsCount;
|
|
2653
|
+
/**
|
|
2654
|
+
* The marker for the current part.
|
|
2655
|
+
*/
|
|
2656
|
+
PartNumberMarker?: PartNumberMarker;
|
|
2657
|
+
/**
|
|
2658
|
+
* When a list is truncated, this element specifies the last part in the list, as well as the value to use for the PartNumberMarker request parameter in a subsequent request.
|
|
2659
|
+
*/
|
|
2660
|
+
NextPartNumberMarker?: NextPartNumberMarker;
|
|
2661
|
+
/**
|
|
2662
|
+
* The maximum number of parts allowed in the response.
|
|
2663
|
+
*/
|
|
2664
|
+
MaxParts?: MaxParts;
|
|
2665
|
+
/**
|
|
2666
|
+
* Indicates whether the returned list of parts is truncated. A value of true indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.
|
|
2667
|
+
*/
|
|
2668
|
+
IsTruncated?: IsTruncated;
|
|
2669
|
+
/**
|
|
2670
|
+
* A container for elements related to a particular part. A response can contain zero or more Parts elements.
|
|
2671
|
+
*/
|
|
2672
|
+
Parts?: PartsList;
|
|
2673
|
+
}
|
|
2674
|
+
export interface GetObjectAttributesRequest {
|
|
2675
|
+
/**
|
|
2676
|
+
* The name of the bucket that contains the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
2677
|
+
*/
|
|
2678
|
+
Bucket: BucketName;
|
|
2679
|
+
/**
|
|
2680
|
+
* The object key.
|
|
2681
|
+
*/
|
|
2682
|
+
Key: ObjectKey;
|
|
2683
|
+
/**
|
|
2684
|
+
* The version ID used to reference a specific version of the object.
|
|
2685
|
+
*/
|
|
2686
|
+
VersionId?: ObjectVersionId;
|
|
2687
|
+
/**
|
|
2688
|
+
* Sets the maximum number of parts to return.
|
|
2689
|
+
*/
|
|
2690
|
+
MaxParts?: MaxParts;
|
|
2691
|
+
/**
|
|
2692
|
+
* Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
|
|
2693
|
+
*/
|
|
2694
|
+
PartNumberMarker?: PartNumberMarker;
|
|
2695
|
+
/**
|
|
2696
|
+
* Specifies the algorithm to use when encrypting the object (for example, AES256).
|
|
2697
|
+
*/
|
|
2698
|
+
SSECustomerAlgorithm?: SSECustomerAlgorithm;
|
|
2699
|
+
/**
|
|
2700
|
+
* Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.
|
|
2701
|
+
*/
|
|
2702
|
+
SSECustomerKey?: SSECustomerKey;
|
|
2703
|
+
/**
|
|
2704
|
+
* Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
|
|
2705
|
+
*/
|
|
2706
|
+
SSECustomerKeyMD5?: SSECustomerKeyMD5;
|
|
2707
|
+
RequestPayer?: RequestPayer;
|
|
2708
|
+
/**
|
|
2709
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2710
|
+
*/
|
|
2711
|
+
ExpectedBucketOwner?: AccountId;
|
|
2712
|
+
/**
|
|
2713
|
+
* An XML header that specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.
|
|
2714
|
+
*/
|
|
2715
|
+
ObjectAttributes: ObjectAttributesList;
|
|
2716
|
+
}
|
|
2472
2717
|
export interface GetObjectLegalHoldOutput {
|
|
2473
2718
|
/**
|
|
2474
|
-
* The current
|
|
2719
|
+
* The current legal hold status for the specified object.
|
|
2475
2720
|
*/
|
|
2476
2721
|
LegalHold?: ObjectLockLegalHold;
|
|
2477
2722
|
}
|
|
2478
2723
|
export interface GetObjectLegalHoldRequest {
|
|
2479
2724
|
/**
|
|
2480
|
-
* The bucket name containing the object whose
|
|
2725
|
+
* The bucket name containing the object whose legal hold status you want to retrieve. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
|
|
2481
2726
|
*/
|
|
2482
2727
|
Bucket: BucketName;
|
|
2483
2728
|
/**
|
|
2484
|
-
* The key name for the object whose
|
|
2729
|
+
* The key name for the object whose legal hold status you want to retrieve.
|
|
2485
2730
|
*/
|
|
2486
2731
|
Key: ObjectKey;
|
|
2487
2732
|
/**
|
|
2488
|
-
* The version ID of the object whose
|
|
2733
|
+
* The version ID of the object whose legal hold status you want to retrieve.
|
|
2489
2734
|
*/
|
|
2490
2735
|
VersionId?: ObjectVersionId;
|
|
2491
2736
|
RequestPayer?: RequestPayer;
|
|
2492
2737
|
/**
|
|
2493
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2738
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2494
2739
|
*/
|
|
2495
2740
|
ExpectedBucketOwner?: AccountId;
|
|
2496
2741
|
}
|
|
@@ -2506,7 +2751,7 @@ declare namespace S3 {
|
|
|
2506
2751
|
*/
|
|
2507
2752
|
Bucket: BucketName;
|
|
2508
2753
|
/**
|
|
2509
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2754
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2510
2755
|
*/
|
|
2511
2756
|
ExpectedBucketOwner?: AccountId;
|
|
2512
2757
|
}
|
|
@@ -2524,7 +2769,7 @@ declare namespace S3 {
|
|
|
2524
2769
|
*/
|
|
2525
2770
|
AcceptRanges?: AcceptRanges;
|
|
2526
2771
|
/**
|
|
2527
|
-
* If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL
|
|
2772
|
+
* If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL-encoded.
|
|
2528
2773
|
*/
|
|
2529
2774
|
Expiration?: Expiration;
|
|
2530
2775
|
/**
|
|
@@ -2540,9 +2785,25 @@ declare namespace S3 {
|
|
|
2540
2785
|
*/
|
|
2541
2786
|
ContentLength?: ContentLength;
|
|
2542
2787
|
/**
|
|
2543
|
-
* An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
|
|
2788
|
+
* An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
|
|
2544
2789
|
*/
|
|
2545
2790
|
ETag?: ETag;
|
|
2791
|
+
/**
|
|
2792
|
+
* The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
2793
|
+
*/
|
|
2794
|
+
ChecksumCRC32?: ChecksumCRC32;
|
|
2795
|
+
/**
|
|
2796
|
+
* The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
2797
|
+
*/
|
|
2798
|
+
ChecksumCRC32C?: ChecksumCRC32C;
|
|
2799
|
+
/**
|
|
2800
|
+
* The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
2801
|
+
*/
|
|
2802
|
+
ChecksumSHA1?: ChecksumSHA1;
|
|
2803
|
+
/**
|
|
2804
|
+
* The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
2805
|
+
*/
|
|
2806
|
+
ChecksumSHA256?: ChecksumSHA256;
|
|
2546
2807
|
/**
|
|
2547
2808
|
* This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.
|
|
2548
2809
|
*/
|
|
@@ -2617,7 +2878,7 @@ declare namespace S3 {
|
|
|
2617
2878
|
*/
|
|
2618
2879
|
ReplicationStatus?: ReplicationStatus;
|
|
2619
2880
|
/**
|
|
2620
|
-
* The count of parts this object has.
|
|
2881
|
+
* The count of parts this object has. This value is only returned if you specify partNumber in your request and the object was uploaded as a multipart upload.
|
|
2621
2882
|
*/
|
|
2622
2883
|
PartsCount?: PartsCount;
|
|
2623
2884
|
/**
|
|
@@ -2639,23 +2900,23 @@ declare namespace S3 {
|
|
|
2639
2900
|
}
|
|
2640
2901
|
export interface GetObjectRequest {
|
|
2641
2902
|
/**
|
|
2642
|
-
* The bucket name containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
2903
|
+
* The bucket name containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
2643
2904
|
*/
|
|
2644
2905
|
Bucket: BucketName;
|
|
2645
2906
|
/**
|
|
2646
|
-
* Return the object only if its entity tag (ETag) is the same as the one specified
|
|
2907
|
+
* Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.
|
|
2647
2908
|
*/
|
|
2648
2909
|
IfMatch?: IfMatch;
|
|
2649
2910
|
/**
|
|
2650
|
-
* Return the object only if it has been modified since the specified time
|
|
2911
|
+
* Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.
|
|
2651
2912
|
*/
|
|
2652
2913
|
IfModifiedSince?: IfModifiedSince;
|
|
2653
2914
|
/**
|
|
2654
|
-
* Return the object only if its entity tag (ETag) is different from the one specified
|
|
2915
|
+
* Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.
|
|
2655
2916
|
*/
|
|
2656
2917
|
IfNoneMatch?: IfNoneMatch;
|
|
2657
2918
|
/**
|
|
2658
|
-
* Return the object only if it has not been modified since the specified time
|
|
2919
|
+
* Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.
|
|
2659
2920
|
*/
|
|
2660
2921
|
IfUnmodifiedSince?: IfUnmodifiedSince;
|
|
2661
2922
|
/**
|
|
@@ -2712,9 +2973,13 @@ declare namespace S3 {
|
|
|
2712
2973
|
*/
|
|
2713
2974
|
PartNumber?: PartNumber;
|
|
2714
2975
|
/**
|
|
2715
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
2976
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2716
2977
|
*/
|
|
2717
2978
|
ExpectedBucketOwner?: AccountId;
|
|
2979
|
+
/**
|
|
2980
|
+
* To retrieve the checksum, this mode must be enabled.
|
|
2981
|
+
*/
|
|
2982
|
+
ChecksumMode?: ChecksumMode;
|
|
2718
2983
|
}
|
|
2719
2984
|
export type GetObjectResponseStatusCode = number;
|
|
2720
2985
|
export interface GetObjectRetentionOutput {
|
|
@@ -2738,7 +3003,7 @@ declare namespace S3 {
|
|
|
2738
3003
|
VersionId?: ObjectVersionId;
|
|
2739
3004
|
RequestPayer?: RequestPayer;
|
|
2740
3005
|
/**
|
|
2741
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
3006
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2742
3007
|
*/
|
|
2743
3008
|
ExpectedBucketOwner?: AccountId;
|
|
2744
3009
|
}
|
|
@@ -2754,7 +3019,7 @@ declare namespace S3 {
|
|
|
2754
3019
|
}
|
|
2755
3020
|
export interface GetObjectTaggingRequest {
|
|
2756
3021
|
/**
|
|
2757
|
-
* The bucket name containing the object for which to get the tagging information. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
3022
|
+
* The bucket name containing the object for which to get the tagging information. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
2758
3023
|
*/
|
|
2759
3024
|
Bucket: BucketName;
|
|
2760
3025
|
/**
|
|
@@ -2766,7 +3031,7 @@ declare namespace S3 {
|
|
|
2766
3031
|
*/
|
|
2767
3032
|
VersionId?: ObjectVersionId;
|
|
2768
3033
|
/**
|
|
2769
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
3034
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2770
3035
|
*/
|
|
2771
3036
|
ExpectedBucketOwner?: AccountId;
|
|
2772
3037
|
RequestPayer?: RequestPayer;
|
|
@@ -2789,7 +3054,7 @@ declare namespace S3 {
|
|
|
2789
3054
|
Key: ObjectKey;
|
|
2790
3055
|
RequestPayer?: RequestPayer;
|
|
2791
3056
|
/**
|
|
2792
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
3057
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2793
3058
|
*/
|
|
2794
3059
|
ExpectedBucketOwner?: AccountId;
|
|
2795
3060
|
}
|
|
@@ -2805,7 +3070,7 @@ declare namespace S3 {
|
|
|
2805
3070
|
*/
|
|
2806
3071
|
Bucket: BucketName;
|
|
2807
3072
|
/**
|
|
2808
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
3073
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2809
3074
|
*/
|
|
2810
3075
|
ExpectedBucketOwner?: AccountId;
|
|
2811
3076
|
}
|
|
@@ -2855,11 +3120,11 @@ declare namespace S3 {
|
|
|
2855
3120
|
export type Grants = Grant[];
|
|
2856
3121
|
export interface HeadBucketRequest {
|
|
2857
3122
|
/**
|
|
2858
|
-
* The bucket name. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
3123
|
+
* The bucket name. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
2859
3124
|
*/
|
|
2860
3125
|
Bucket: BucketName;
|
|
2861
3126
|
/**
|
|
2862
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
3127
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
2863
3128
|
*/
|
|
2864
3129
|
ExpectedBucketOwner?: AccountId;
|
|
2865
3130
|
}
|
|
@@ -2873,7 +3138,7 @@ declare namespace S3 {
|
|
|
2873
3138
|
*/
|
|
2874
3139
|
AcceptRanges?: AcceptRanges;
|
|
2875
3140
|
/**
|
|
2876
|
-
* If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL
|
|
3141
|
+
* If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL-encoded.
|
|
2877
3142
|
*/
|
|
2878
3143
|
Expiration?: Expiration;
|
|
2879
3144
|
/**
|
|
@@ -2893,7 +3158,23 @@ declare namespace S3 {
|
|
|
2893
3158
|
*/
|
|
2894
3159
|
ContentLength?: ContentLength;
|
|
2895
3160
|
/**
|
|
2896
|
-
*
|
|
3161
|
+
* The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
3162
|
+
*/
|
|
3163
|
+
ChecksumCRC32?: ChecksumCRC32;
|
|
3164
|
+
/**
|
|
3165
|
+
* The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
3166
|
+
*/
|
|
3167
|
+
ChecksumCRC32C?: ChecksumCRC32C;
|
|
3168
|
+
/**
|
|
3169
|
+
* The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
3170
|
+
*/
|
|
3171
|
+
ChecksumSHA1?: ChecksumSHA1;
|
|
3172
|
+
/**
|
|
3173
|
+
* The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
3174
|
+
*/
|
|
3175
|
+
ChecksumSHA256?: ChecksumSHA256;
|
|
3176
|
+
/**
|
|
3177
|
+
* An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
|
|
2897
3178
|
*/
|
|
2898
3179
|
ETag?: ETag;
|
|
2899
3180
|
/**
|
|
@@ -2962,11 +3243,11 @@ declare namespace S3 {
|
|
|
2962
3243
|
StorageClass?: StorageClass;
|
|
2963
3244
|
RequestCharged?: RequestCharged;
|
|
2964
3245
|
/**
|
|
2965
|
-
* Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule. In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (GetObject) or object metadata (HeadObject) from these buckets, Amazon S3 will return the x-amz-replication-status header in the response as follows:
|
|
3246
|
+
* Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule. In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (GetObject) or object metadata (HeadObject) from these buckets, Amazon S3 will return the x-amz-replication-status header in the response as follows: If requesting an object from the source bucket, Amazon S3 will return the x-amz-replication-status header if the object in your request is eligible for replication. For example, suppose that in your replication configuration, you specify object prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix TaxDocs. Any objects you upload with this key name prefix, for example TaxDocs/document1.pdf, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the x-amz-replication-status header with value PENDING, COMPLETED or FAILED indicating object replication status. If requesting an object from a destination bucket, Amazon S3 will return the x-amz-replication-status header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress. When replicating objects to multiple destination buckets, the x-amz-replication-status header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED. For more information, see Replication.
|
|
2966
3247
|
*/
|
|
2967
3248
|
ReplicationStatus?: ReplicationStatus;
|
|
2968
3249
|
/**
|
|
2969
|
-
* The count of parts this object has.
|
|
3250
|
+
* The count of parts this object has. This value is only returned if you specify partNumber in your request and the object was uploaded as a multipart upload.
|
|
2970
3251
|
*/
|
|
2971
3252
|
PartsCount?: PartsCount;
|
|
2972
3253
|
/**
|
|
@@ -2984,23 +3265,23 @@ declare namespace S3 {
|
|
|
2984
3265
|
}
|
|
2985
3266
|
export interface HeadObjectRequest {
|
|
2986
3267
|
/**
|
|
2987
|
-
* The name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
3268
|
+
* The name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
2988
3269
|
*/
|
|
2989
3270
|
Bucket: BucketName;
|
|
2990
3271
|
/**
|
|
2991
|
-
* Return the object only if its entity tag (ETag) is the same as the one specified
|
|
3272
|
+
* Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.
|
|
2992
3273
|
*/
|
|
2993
3274
|
IfMatch?: IfMatch;
|
|
2994
3275
|
/**
|
|
2995
|
-
* Return the object only if it has been modified since the specified time
|
|
3276
|
+
* Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.
|
|
2996
3277
|
*/
|
|
2997
3278
|
IfModifiedSince?: IfModifiedSince;
|
|
2998
3279
|
/**
|
|
2999
|
-
* Return the object only if its entity tag (ETag) is different from the one specified
|
|
3280
|
+
* Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.
|
|
3000
3281
|
*/
|
|
3001
3282
|
IfNoneMatch?: IfNoneMatch;
|
|
3002
3283
|
/**
|
|
3003
|
-
* Return the object only if it has not been modified since the specified time
|
|
3284
|
+
* Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.
|
|
3004
3285
|
*/
|
|
3005
3286
|
IfUnmodifiedSince?: IfUnmodifiedSince;
|
|
3006
3287
|
/**
|
|
@@ -3033,9 +3314,13 @@ declare namespace S3 {
|
|
|
3033
3314
|
*/
|
|
3034
3315
|
PartNumber?: PartNumber;
|
|
3035
3316
|
/**
|
|
3036
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
3317
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
3037
3318
|
*/
|
|
3038
3319
|
ExpectedBucketOwner?: AccountId;
|
|
3320
|
+
/**
|
|
3321
|
+
* To retrieve the checksum, this parameter must be enabled. In addition, if you enable ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must have permission to use the kms:Decrypt action for the request to succeed.
|
|
3322
|
+
*/
|
|
3323
|
+
ChecksumMode?: ChecksumMode;
|
|
3039
3324
|
}
|
|
3040
3325
|
export type HostName = string;
|
|
3041
3326
|
export type HttpErrorCodeReturnedEquals = string;
|
|
@@ -3181,7 +3466,7 @@ declare namespace S3 {
|
|
|
3181
3466
|
export type InventoryFrequency = "Daily"|"Weekly"|string;
|
|
3182
3467
|
export type InventoryId = string;
|
|
3183
3468
|
export type InventoryIncludedObjectVersions = "All"|"Current"|string;
|
|
3184
|
-
export type InventoryOptionalField = "Size"|"LastModifiedDate"|"StorageClass"|"ETag"|"IsMultipartUploaded"|"ReplicationStatus"|"EncryptionStatus"|"ObjectLockRetainUntilDate"|"ObjectLockMode"|"ObjectLockLegalHoldStatus"|"IntelligentTieringAccessTier"|"BucketKeyStatus"|string;
|
|
3469
|
+
export type InventoryOptionalField = "Size"|"LastModifiedDate"|"StorageClass"|"ETag"|"IsMultipartUploaded"|"ReplicationStatus"|"EncryptionStatus"|"ObjectLockRetainUntilDate"|"ObjectLockMode"|"ObjectLockLegalHoldStatus"|"IntelligentTieringAccessTier"|"BucketKeyStatus"|"ChecksumAlgorithm"|string;
|
|
3185
3470
|
export type InventoryOptionalFields = InventoryOptionalField[];
|
|
3186
3471
|
export interface InventoryS3BucketDestination {
|
|
3187
3472
|
/**
|
|
@@ -3281,7 +3566,7 @@ declare namespace S3 {
|
|
|
3281
3566
|
*/
|
|
3282
3567
|
Prefix?: Prefix;
|
|
3283
3568
|
/**
|
|
3284
|
-
* The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix, Tag, or And specified. Filter is required if the LifecycleRule does not
|
|
3569
|
+
* The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix, Tag, or And specified. Filter is required if the LifecycleRule does not contain a Prefix element.
|
|
3285
3570
|
*/
|
|
3286
3571
|
Filter?: LifecycleRuleFilter;
|
|
3287
3572
|
/**
|
|
@@ -3365,7 +3650,7 @@ declare namespace S3 {
|
|
|
3365
3650
|
*/
|
|
3366
3651
|
ContinuationToken?: Token;
|
|
3367
3652
|
/**
|
|
3368
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
3653
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
3369
3654
|
*/
|
|
3370
3655
|
ExpectedBucketOwner?: AccountId;
|
|
3371
3656
|
}
|
|
@@ -3425,7 +3710,7 @@ declare namespace S3 {
|
|
|
3425
3710
|
*/
|
|
3426
3711
|
ContinuationToken?: Token;
|
|
3427
3712
|
/**
|
|
3428
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
3713
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
3429
3714
|
*/
|
|
3430
3715
|
ExpectedBucketOwner?: AccountId;
|
|
3431
3716
|
}
|
|
@@ -3457,13 +3742,13 @@ declare namespace S3 {
|
|
|
3457
3742
|
*/
|
|
3458
3743
|
ContinuationToken?: Token;
|
|
3459
3744
|
/**
|
|
3460
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
3745
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
3461
3746
|
*/
|
|
3462
3747
|
ExpectedBucketOwner?: AccountId;
|
|
3463
3748
|
}
|
|
3464
3749
|
export interface ListBucketsOutput {
|
|
3465
3750
|
/**
|
|
3466
|
-
* The list of buckets owned by the
|
|
3751
|
+
* The list of buckets owned by the requester.
|
|
3467
3752
|
*/
|
|
3468
3753
|
Buckets?: Buckets;
|
|
3469
3754
|
/**
|
|
@@ -3523,7 +3808,7 @@ declare namespace S3 {
|
|
|
3523
3808
|
}
|
|
3524
3809
|
export interface ListMultipartUploadsRequest {
|
|
3525
3810
|
/**
|
|
3526
|
-
* The name of the bucket to which the multipart upload was initiated. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
3811
|
+
* The name of the bucket to which the multipart upload was initiated. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
3527
3812
|
*/
|
|
3528
3813
|
Bucket: BucketName;
|
|
3529
3814
|
/**
|
|
@@ -3548,7 +3833,7 @@ declare namespace S3 {
|
|
|
3548
3833
|
*/
|
|
3549
3834
|
UploadIdMarker?: UploadIdMarker;
|
|
3550
3835
|
/**
|
|
3551
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
3836
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
3552
3837
|
*/
|
|
3553
3838
|
ExpectedBucketOwner?: AccountId;
|
|
3554
3839
|
}
|
|
@@ -3633,7 +3918,7 @@ declare namespace S3 {
|
|
|
3633
3918
|
*/
|
|
3634
3919
|
VersionIdMarker?: VersionIdMarker;
|
|
3635
3920
|
/**
|
|
3636
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
3921
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
3637
3922
|
*/
|
|
3638
3923
|
ExpectedBucketOwner?: AccountId;
|
|
3639
3924
|
}
|
|
@@ -3681,7 +3966,7 @@ declare namespace S3 {
|
|
|
3681
3966
|
}
|
|
3682
3967
|
export interface ListObjectsRequest {
|
|
3683
3968
|
/**
|
|
3684
|
-
* The name of the bucket containing the objects. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
3969
|
+
* The name of the bucket containing the objects. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
3685
3970
|
*/
|
|
3686
3971
|
Bucket: BucketName;
|
|
3687
3972
|
/**
|
|
@@ -3706,7 +3991,7 @@ declare namespace S3 {
|
|
|
3706
3991
|
*/
|
|
3707
3992
|
RequestPayer?: RequestPayer;
|
|
3708
3993
|
/**
|
|
3709
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
3994
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
3710
3995
|
*/
|
|
3711
3996
|
ExpectedBucketOwner?: AccountId;
|
|
3712
3997
|
}
|
|
@@ -3720,7 +4005,7 @@ declare namespace S3 {
|
|
|
3720
4005
|
*/
|
|
3721
4006
|
Contents?: ObjectList;
|
|
3722
4007
|
/**
|
|
3723
|
-
* The bucket name. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
4008
|
+
* The bucket name. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
3724
4009
|
*/
|
|
3725
4010
|
Name?: BucketName;
|
|
3726
4011
|
/**
|
|
@@ -3762,7 +4047,7 @@ declare namespace S3 {
|
|
|
3762
4047
|
}
|
|
3763
4048
|
export interface ListObjectsV2Request {
|
|
3764
4049
|
/**
|
|
3765
|
-
* Bucket name to list. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
4050
|
+
* Bucket name to list. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
3766
4051
|
*/
|
|
3767
4052
|
Bucket: BucketName;
|
|
3768
4053
|
/**
|
|
@@ -3798,7 +4083,7 @@ declare namespace S3 {
|
|
|
3798
4083
|
*/
|
|
3799
4084
|
RequestPayer?: RequestPayer;
|
|
3800
4085
|
/**
|
|
3801
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
4086
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
3802
4087
|
*/
|
|
3803
4088
|
ExpectedBucketOwner?: AccountId;
|
|
3804
4089
|
}
|
|
@@ -3856,10 +4141,14 @@ declare namespace S3 {
|
|
|
3856
4141
|
*/
|
|
3857
4142
|
StorageClass?: StorageClass;
|
|
3858
4143
|
RequestCharged?: RequestCharged;
|
|
4144
|
+
/**
|
|
4145
|
+
* The algorithm that was used to create a checksum of the object.
|
|
4146
|
+
*/
|
|
4147
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
3859
4148
|
}
|
|
3860
4149
|
export interface ListPartsRequest {
|
|
3861
4150
|
/**
|
|
3862
|
-
* The name of the bucket to which the parts are being uploaded. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
4151
|
+
* The name of the bucket to which the parts are being uploaded. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
3863
4152
|
*/
|
|
3864
4153
|
Bucket: BucketName;
|
|
3865
4154
|
/**
|
|
@@ -3880,9 +4169,21 @@ declare namespace S3 {
|
|
|
3880
4169
|
UploadId: MultipartUploadId;
|
|
3881
4170
|
RequestPayer?: RequestPayer;
|
|
3882
4171
|
/**
|
|
3883
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
4172
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
3884
4173
|
*/
|
|
3885
4174
|
ExpectedBucketOwner?: AccountId;
|
|
4175
|
+
/**
|
|
4176
|
+
* The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
|
|
4177
|
+
*/
|
|
4178
|
+
SSECustomerAlgorithm?: SSECustomerAlgorithm;
|
|
4179
|
+
/**
|
|
4180
|
+
* The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
|
|
4181
|
+
*/
|
|
4182
|
+
SSECustomerKey?: SSECustomerKey;
|
|
4183
|
+
/**
|
|
4184
|
+
* The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
|
|
4185
|
+
*/
|
|
4186
|
+
SSECustomerKeyMD5?: SSECustomerKeyMD5;
|
|
3886
4187
|
}
|
|
3887
4188
|
export type Location = string;
|
|
3888
4189
|
export type LocationPrefix = string;
|
|
@@ -4005,6 +4306,10 @@ declare namespace S3 {
|
|
|
4005
4306
|
* Identifies who initiated the multipart upload.
|
|
4006
4307
|
*/
|
|
4007
4308
|
Initiator?: Initiator;
|
|
4309
|
+
/**
|
|
4310
|
+
* The algorithm that was used to create a checksum of the object.
|
|
4311
|
+
*/
|
|
4312
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
4008
4313
|
}
|
|
4009
4314
|
export type MultipartUploadId = string;
|
|
4010
4315
|
export type MultipartUploadList = MultipartUpload[];
|
|
@@ -4016,7 +4321,7 @@ declare namespace S3 {
|
|
|
4016
4321
|
export type NextVersionIdMarker = string;
|
|
4017
4322
|
export interface NoncurrentVersionExpiration {
|
|
4018
4323
|
/**
|
|
4019
|
-
* Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon S3 User Guide.
|
|
4324
|
+
* Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. The value must be a non-zero positive integer. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon S3 User Guide.
|
|
4020
4325
|
*/
|
|
4021
4326
|
NoncurrentDays?: Days;
|
|
4022
4327
|
/**
|
|
@@ -4085,9 +4390,13 @@ declare namespace S3 {
|
|
|
4085
4390
|
*/
|
|
4086
4391
|
LastModified?: LastModified;
|
|
4087
4392
|
/**
|
|
4088
|
-
* The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below: Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data. Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data. If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption.
|
|
4393
|
+
* The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below: Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data. Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data. If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption. If an object is larger than 16 MB, the Amazon Web Services Management Console will upload or copy that object as a Multipart Upload, and therefore the ETag will not be an MD5 digest.
|
|
4089
4394
|
*/
|
|
4090
4395
|
ETag?: ETag;
|
|
4396
|
+
/**
|
|
4397
|
+
* The algorithm that was used to create a checksum of the object.
|
|
4398
|
+
*/
|
|
4399
|
+
ChecksumAlgorithm?: ChecksumAlgorithmList;
|
|
4091
4400
|
/**
|
|
4092
4401
|
* Size in bytes of the object
|
|
4093
4402
|
*/
|
|
@@ -4101,6 +4410,8 @@ declare namespace S3 {
|
|
|
4101
4410
|
*/
|
|
4102
4411
|
Owner?: Owner;
|
|
4103
4412
|
}
|
|
4413
|
+
export type ObjectAttributes = "ETag"|"Checksum"|"ObjectParts"|"StorageClass"|"ObjectSize"|string;
|
|
4414
|
+
export type ObjectAttributesList = ObjectAttributes[];
|
|
4104
4415
|
export type ObjectCannedACL = "private"|"public-read"|"public-read-write"|"authenticated-read"|"aws-exec-read"|"bucket-owner-read"|"bucket-owner-full-control"|string;
|
|
4105
4416
|
export interface ObjectIdentifier {
|
|
4106
4417
|
/**
|
|
@@ -4129,7 +4440,7 @@ declare namespace S3 {
|
|
|
4129
4440
|
export type ObjectLockEnabledForBucket = boolean;
|
|
4130
4441
|
export interface ObjectLockLegalHold {
|
|
4131
4442
|
/**
|
|
4132
|
-
* Indicates whether the specified object has a
|
|
4443
|
+
* Indicates whether the specified object has a legal hold in place.
|
|
4133
4444
|
*/
|
|
4134
4445
|
Status?: ObjectLockLegalHoldStatus;
|
|
4135
4446
|
}
|
|
@@ -4155,6 +4466,33 @@ declare namespace S3 {
|
|
|
4155
4466
|
}
|
|
4156
4467
|
export type ObjectLockToken = string;
|
|
4157
4468
|
export type ObjectOwnership = "BucketOwnerPreferred"|"ObjectWriter"|"BucketOwnerEnforced"|string;
|
|
4469
|
+
export interface ObjectPart {
|
|
4470
|
+
/**
|
|
4471
|
+
* The part number identifying the part. This value is a positive integer between 1 and 10,000.
|
|
4472
|
+
*/
|
|
4473
|
+
PartNumber?: PartNumber;
|
|
4474
|
+
/**
|
|
4475
|
+
* The size of the uploaded part in bytes.
|
|
4476
|
+
*/
|
|
4477
|
+
Size?: Size;
|
|
4478
|
+
/**
|
|
4479
|
+
* This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
|
|
4480
|
+
*/
|
|
4481
|
+
ChecksumCRC32?: ChecksumCRC32;
|
|
4482
|
+
/**
|
|
4483
|
+
* The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
4484
|
+
*/
|
|
4485
|
+
ChecksumCRC32C?: ChecksumCRC32C;
|
|
4486
|
+
/**
|
|
4487
|
+
* The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
4488
|
+
*/
|
|
4489
|
+
ChecksumSHA1?: ChecksumSHA1;
|
|
4490
|
+
/**
|
|
4491
|
+
* The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
4492
|
+
*/
|
|
4493
|
+
ChecksumSHA256?: ChecksumSHA256;
|
|
4494
|
+
}
|
|
4495
|
+
export type ObjectSize = number;
|
|
4158
4496
|
export type ObjectSizeGreaterThanBytes = number;
|
|
4159
4497
|
export type ObjectSizeLessThanBytes = number;
|
|
4160
4498
|
export type ObjectStorageClass = "STANDARD"|"REDUCED_REDUNDANCY"|"GLACIER"|"STANDARD_IA"|"ONEZONE_IA"|"INTELLIGENT_TIERING"|"DEEP_ARCHIVE"|"OUTPOSTS"|"GLACIER_IR"|string;
|
|
@@ -4163,6 +4501,10 @@ declare namespace S3 {
|
|
|
4163
4501
|
* The entity tag is an MD5 hash of that version of the object.
|
|
4164
4502
|
*/
|
|
4165
4503
|
ETag?: ETag;
|
|
4504
|
+
/**
|
|
4505
|
+
* The algorithm that was used to create a checksum of the object.
|
|
4506
|
+
*/
|
|
4507
|
+
ChecksumAlgorithm?: ChecksumAlgorithmList;
|
|
4166
4508
|
/**
|
|
4167
4509
|
* Size in bytes of the object.
|
|
4168
4510
|
*/
|
|
@@ -4251,11 +4593,28 @@ declare namespace S3 {
|
|
|
4251
4593
|
* Size in bytes of the uploaded part data.
|
|
4252
4594
|
*/
|
|
4253
4595
|
Size?: Size;
|
|
4596
|
+
/**
|
|
4597
|
+
* This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
|
|
4598
|
+
*/
|
|
4599
|
+
ChecksumCRC32?: ChecksumCRC32;
|
|
4600
|
+
/**
|
|
4601
|
+
* The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
4602
|
+
*/
|
|
4603
|
+
ChecksumCRC32C?: ChecksumCRC32C;
|
|
4604
|
+
/**
|
|
4605
|
+
* The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
4606
|
+
*/
|
|
4607
|
+
ChecksumSHA1?: ChecksumSHA1;
|
|
4608
|
+
/**
|
|
4609
|
+
* This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
|
|
4610
|
+
*/
|
|
4611
|
+
ChecksumSHA256?: ChecksumSHA256;
|
|
4254
4612
|
}
|
|
4255
4613
|
export type PartNumber = number;
|
|
4256
4614
|
export type PartNumberMarker = number;
|
|
4257
4615
|
export type Parts = Part[];
|
|
4258
4616
|
export type PartsCount = number;
|
|
4617
|
+
export type PartsList = ObjectPart[];
|
|
4259
4618
|
export type Payer = "Requester"|"BucketOwner"|string;
|
|
4260
4619
|
export type Permission = "FULL_CONTROL"|"WRITE"|"WRITE_ACP"|"READ"|"READ_ACP"|string;
|
|
4261
4620
|
export type Policy = string;
|
|
@@ -4290,7 +4649,7 @@ declare namespace S3 {
|
|
|
4290
4649
|
export type Protocol = "http"|"https"|string;
|
|
4291
4650
|
export interface PublicAccessBlockConfiguration {
|
|
4292
4651
|
/**
|
|
4293
|
-
* Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to TRUE causes the following behavior: PUT Bucket
|
|
4652
|
+
* Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to TRUE causes the following behavior: PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL is public. PUT Object calls fail if the request includes a public ACL. PUT Bucket calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs.
|
|
4294
4653
|
*/
|
|
4295
4654
|
BlockPublicAcls?: Setting;
|
|
4296
4655
|
/**
|
|
@@ -4316,9 +4675,13 @@ declare namespace S3 {
|
|
|
4316
4675
|
*/
|
|
4317
4676
|
AccelerateConfiguration: AccelerateConfiguration;
|
|
4318
4677
|
/**
|
|
4319
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
4678
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4320
4679
|
*/
|
|
4321
4680
|
ExpectedBucketOwner?: AccountId;
|
|
4681
|
+
/**
|
|
4682
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
|
|
4683
|
+
*/
|
|
4684
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
4322
4685
|
}
|
|
4323
4686
|
export interface PutBucketAclRequest {
|
|
4324
4687
|
/**
|
|
@@ -4337,6 +4700,10 @@ declare namespace S3 {
|
|
|
4337
4700
|
* The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864. For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
|
|
4338
4701
|
*/
|
|
4339
4702
|
ContentMD5?: ContentMD5;
|
|
4703
|
+
/**
|
|
4704
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
|
|
4705
|
+
*/
|
|
4706
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
4340
4707
|
/**
|
|
4341
4708
|
* Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
|
|
4342
4709
|
*/
|
|
@@ -4358,7 +4725,7 @@ declare namespace S3 {
|
|
|
4358
4725
|
*/
|
|
4359
4726
|
GrantWriteACP?: GrantWriteACP;
|
|
4360
4727
|
/**
|
|
4361
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
4728
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4362
4729
|
*/
|
|
4363
4730
|
ExpectedBucketOwner?: AccountId;
|
|
4364
4731
|
}
|
|
@@ -4376,7 +4743,7 @@ declare namespace S3 {
|
|
|
4376
4743
|
*/
|
|
4377
4744
|
AnalyticsConfiguration: AnalyticsConfiguration;
|
|
4378
4745
|
/**
|
|
4379
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
4746
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4380
4747
|
*/
|
|
4381
4748
|
ExpectedBucketOwner?: AccountId;
|
|
4382
4749
|
}
|
|
@@ -4394,7 +4761,11 @@ declare namespace S3 {
|
|
|
4394
4761
|
*/
|
|
4395
4762
|
ContentMD5?: ContentMD5;
|
|
4396
4763
|
/**
|
|
4397
|
-
*
|
|
4764
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
|
|
4765
|
+
*/
|
|
4766
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
4767
|
+
/**
|
|
4768
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4398
4769
|
*/
|
|
4399
4770
|
ExpectedBucketOwner?: AccountId;
|
|
4400
4771
|
}
|
|
@@ -4407,9 +4778,13 @@ declare namespace S3 {
|
|
|
4407
4778
|
* The base64-encoded 128-bit MD5 digest of the server-side encryption configuration. For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
|
|
4408
4779
|
*/
|
|
4409
4780
|
ContentMD5?: ContentMD5;
|
|
4781
|
+
/**
|
|
4782
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
|
|
4783
|
+
*/
|
|
4784
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
4410
4785
|
ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration;
|
|
4411
4786
|
/**
|
|
4412
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
4787
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4413
4788
|
*/
|
|
4414
4789
|
ExpectedBucketOwner?: AccountId;
|
|
4415
4790
|
}
|
|
@@ -4441,7 +4816,7 @@ declare namespace S3 {
|
|
|
4441
4816
|
*/
|
|
4442
4817
|
InventoryConfiguration: InventoryConfiguration;
|
|
4443
4818
|
/**
|
|
4444
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
4819
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4445
4820
|
*/
|
|
4446
4821
|
ExpectedBucketOwner?: AccountId;
|
|
4447
4822
|
}
|
|
@@ -4450,12 +4825,16 @@ declare namespace S3 {
|
|
|
4450
4825
|
* The name of the bucket for which to set the configuration.
|
|
4451
4826
|
*/
|
|
4452
4827
|
Bucket: BucketName;
|
|
4828
|
+
/**
|
|
4829
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
|
|
4830
|
+
*/
|
|
4831
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
4453
4832
|
/**
|
|
4454
4833
|
* Container for lifecycle rules. You can add as many as 1,000 rules.
|
|
4455
4834
|
*/
|
|
4456
4835
|
LifecycleConfiguration?: BucketLifecycleConfiguration;
|
|
4457
4836
|
/**
|
|
4458
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
4837
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4459
4838
|
*/
|
|
4460
4839
|
ExpectedBucketOwner?: AccountId;
|
|
4461
4840
|
}
|
|
@@ -4468,12 +4847,16 @@ declare namespace S3 {
|
|
|
4468
4847
|
* For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
|
|
4469
4848
|
*/
|
|
4470
4849
|
ContentMD5?: ContentMD5;
|
|
4850
|
+
/**
|
|
4851
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
|
|
4852
|
+
*/
|
|
4853
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
4471
4854
|
/**
|
|
4472
4855
|
*
|
|
4473
4856
|
*/
|
|
4474
4857
|
LifecycleConfiguration?: LifecycleConfiguration;
|
|
4475
4858
|
/**
|
|
4476
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
4859
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4477
4860
|
*/
|
|
4478
4861
|
ExpectedBucketOwner?: AccountId;
|
|
4479
4862
|
}
|
|
@@ -4491,7 +4874,11 @@ declare namespace S3 {
|
|
|
4491
4874
|
*/
|
|
4492
4875
|
ContentMD5?: ContentMD5;
|
|
4493
4876
|
/**
|
|
4494
|
-
*
|
|
4877
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
|
|
4878
|
+
*/
|
|
4879
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
4880
|
+
/**
|
|
4881
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4495
4882
|
*/
|
|
4496
4883
|
ExpectedBucketOwner?: AccountId;
|
|
4497
4884
|
}
|
|
@@ -4509,7 +4896,7 @@ declare namespace S3 {
|
|
|
4509
4896
|
*/
|
|
4510
4897
|
MetricsConfiguration: MetricsConfiguration;
|
|
4511
4898
|
/**
|
|
4512
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
4899
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4513
4900
|
*/
|
|
4514
4901
|
ExpectedBucketOwner?: AccountId;
|
|
4515
4902
|
}
|
|
@@ -4520,7 +4907,7 @@ declare namespace S3 {
|
|
|
4520
4907
|
Bucket: BucketName;
|
|
4521
4908
|
NotificationConfiguration: NotificationConfiguration;
|
|
4522
4909
|
/**
|
|
4523
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
4910
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4524
4911
|
*/
|
|
4525
4912
|
ExpectedBucketOwner?: AccountId;
|
|
4526
4913
|
/**
|
|
@@ -4537,12 +4924,16 @@ declare namespace S3 {
|
|
|
4537
4924
|
* The MD5 hash of the PutPublicAccessBlock request body. For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
|
|
4538
4925
|
*/
|
|
4539
4926
|
ContentMD5?: ContentMD5;
|
|
4927
|
+
/**
|
|
4928
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
|
|
4929
|
+
*/
|
|
4930
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
4540
4931
|
/**
|
|
4541
4932
|
* The container for the configuration.
|
|
4542
4933
|
*/
|
|
4543
4934
|
NotificationConfiguration: NotificationConfigurationDeprecated;
|
|
4544
4935
|
/**
|
|
4545
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
4936
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4546
4937
|
*/
|
|
4547
4938
|
ExpectedBucketOwner?: AccountId;
|
|
4548
4939
|
}
|
|
@@ -4556,7 +4947,7 @@ declare namespace S3 {
|
|
|
4556
4947
|
*/
|
|
4557
4948
|
ContentMD5?: ContentMD5;
|
|
4558
4949
|
/**
|
|
4559
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
4950
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4560
4951
|
*/
|
|
4561
4952
|
ExpectedBucketOwner?: AccountId;
|
|
4562
4953
|
/**
|
|
@@ -4573,6 +4964,10 @@ declare namespace S3 {
|
|
|
4573
4964
|
* The MD5 hash of the request body. For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
|
|
4574
4965
|
*/
|
|
4575
4966
|
ContentMD5?: ContentMD5;
|
|
4967
|
+
/**
|
|
4968
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
|
|
4969
|
+
*/
|
|
4970
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
4576
4971
|
/**
|
|
4577
4972
|
* Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.
|
|
4578
4973
|
*/
|
|
@@ -4582,7 +4977,7 @@ declare namespace S3 {
|
|
|
4582
4977
|
*/
|
|
4583
4978
|
Policy: Policy;
|
|
4584
4979
|
/**
|
|
4585
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
4980
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4586
4981
|
*/
|
|
4587
4982
|
ExpectedBucketOwner?: AccountId;
|
|
4588
4983
|
}
|
|
@@ -4595,13 +4990,17 @@ declare namespace S3 {
|
|
|
4595
4990
|
* The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864. For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
|
|
4596
4991
|
*/
|
|
4597
4992
|
ContentMD5?: ContentMD5;
|
|
4993
|
+
/**
|
|
4994
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
|
|
4995
|
+
*/
|
|
4996
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
4598
4997
|
ReplicationConfiguration: ReplicationConfiguration;
|
|
4599
4998
|
/**
|
|
4600
4999
|
* A token to allow Object Lock to be enabled for an existing bucket.
|
|
4601
5000
|
*/
|
|
4602
5001
|
Token?: ObjectLockToken;
|
|
4603
5002
|
/**
|
|
4604
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
5003
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4605
5004
|
*/
|
|
4606
5005
|
ExpectedBucketOwner?: AccountId;
|
|
4607
5006
|
}
|
|
@@ -4614,12 +5013,16 @@ declare namespace S3 {
|
|
|
4614
5013
|
* The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864. For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
|
|
4615
5014
|
*/
|
|
4616
5015
|
ContentMD5?: ContentMD5;
|
|
5016
|
+
/**
|
|
5017
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
|
|
5018
|
+
*/
|
|
5019
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
4617
5020
|
/**
|
|
4618
5021
|
* Container for Payer.
|
|
4619
5022
|
*/
|
|
4620
5023
|
RequestPaymentConfiguration: RequestPaymentConfiguration;
|
|
4621
5024
|
/**
|
|
4622
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
5025
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4623
5026
|
*/
|
|
4624
5027
|
ExpectedBucketOwner?: AccountId;
|
|
4625
5028
|
}
|
|
@@ -4632,12 +5035,16 @@ declare namespace S3 {
|
|
|
4632
5035
|
* The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864. For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
|
|
4633
5036
|
*/
|
|
4634
5037
|
ContentMD5?: ContentMD5;
|
|
5038
|
+
/**
|
|
5039
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
|
|
5040
|
+
*/
|
|
5041
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
4635
5042
|
/**
|
|
4636
5043
|
* Container for the TagSet and Tag elements.
|
|
4637
5044
|
*/
|
|
4638
5045
|
Tagging: Tagging;
|
|
4639
5046
|
/**
|
|
4640
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
5047
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4641
5048
|
*/
|
|
4642
5049
|
ExpectedBucketOwner?: AccountId;
|
|
4643
5050
|
}
|
|
@@ -4650,6 +5057,10 @@ declare namespace S3 {
|
|
|
4650
5057
|
* >The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864. For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
|
|
4651
5058
|
*/
|
|
4652
5059
|
ContentMD5?: ContentMD5;
|
|
5060
|
+
/**
|
|
5061
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
|
|
5062
|
+
*/
|
|
5063
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
4653
5064
|
/**
|
|
4654
5065
|
* The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.
|
|
4655
5066
|
*/
|
|
@@ -4659,7 +5070,7 @@ declare namespace S3 {
|
|
|
4659
5070
|
*/
|
|
4660
5071
|
VersioningConfiguration: VersioningConfiguration;
|
|
4661
5072
|
/**
|
|
4662
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
5073
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4663
5074
|
*/
|
|
4664
5075
|
ExpectedBucketOwner?: AccountId;
|
|
4665
5076
|
}
|
|
@@ -4672,12 +5083,16 @@ declare namespace S3 {
|
|
|
4672
5083
|
* The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864. For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
|
|
4673
5084
|
*/
|
|
4674
5085
|
ContentMD5?: ContentMD5;
|
|
5086
|
+
/**
|
|
5087
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
|
|
5088
|
+
*/
|
|
5089
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
4675
5090
|
/**
|
|
4676
5091
|
* Container for the request.
|
|
4677
5092
|
*/
|
|
4678
5093
|
WebsiteConfiguration: WebsiteConfiguration;
|
|
4679
5094
|
/**
|
|
4680
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
5095
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4681
5096
|
*/
|
|
4682
5097
|
ExpectedBucketOwner?: AccountId;
|
|
4683
5098
|
}
|
|
@@ -4701,6 +5116,10 @@ declare namespace S3 {
|
|
|
4701
5116
|
* The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.> For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
|
|
4702
5117
|
*/
|
|
4703
5118
|
ContentMD5?: ContentMD5;
|
|
5119
|
+
/**
|
|
5120
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
|
|
5121
|
+
*/
|
|
5122
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
4704
5123
|
/**
|
|
4705
5124
|
* Allows grantee the read, write, read ACP, and write ACP permissions on the bucket. This action is not supported by Amazon S3 on Outposts.
|
|
4706
5125
|
*/
|
|
@@ -4722,7 +5141,7 @@ declare namespace S3 {
|
|
|
4722
5141
|
*/
|
|
4723
5142
|
GrantWriteACP?: GrantWriteACP;
|
|
4724
5143
|
/**
|
|
4725
|
-
* Key for which the PUT action was initiated. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
5144
|
+
* Key for which the PUT action was initiated. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
4726
5145
|
*/
|
|
4727
5146
|
Key: ObjectKey;
|
|
4728
5147
|
RequestPayer?: RequestPayer;
|
|
@@ -4731,7 +5150,7 @@ declare namespace S3 {
|
|
|
4731
5150
|
*/
|
|
4732
5151
|
VersionId?: ObjectVersionId;
|
|
4733
5152
|
/**
|
|
4734
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
5153
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4735
5154
|
*/
|
|
4736
5155
|
ExpectedBucketOwner?: AccountId;
|
|
4737
5156
|
}
|
|
@@ -4740,20 +5159,20 @@ declare namespace S3 {
|
|
|
4740
5159
|
}
|
|
4741
5160
|
export interface PutObjectLegalHoldRequest {
|
|
4742
5161
|
/**
|
|
4743
|
-
* The bucket name containing the object that you want to place a
|
|
5162
|
+
* The bucket name containing the object that you want to place a legal hold on. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
|
|
4744
5163
|
*/
|
|
4745
5164
|
Bucket: BucketName;
|
|
4746
5165
|
/**
|
|
4747
|
-
* The key name for the object that you want to place a
|
|
5166
|
+
* The key name for the object that you want to place a legal hold on.
|
|
4748
5167
|
*/
|
|
4749
5168
|
Key: ObjectKey;
|
|
4750
5169
|
/**
|
|
4751
|
-
* Container element for the
|
|
5170
|
+
* Container element for the legal hold configuration you want to apply to the specified object.
|
|
4752
5171
|
*/
|
|
4753
5172
|
LegalHold?: ObjectLockLegalHold;
|
|
4754
5173
|
RequestPayer?: RequestPayer;
|
|
4755
5174
|
/**
|
|
4756
|
-
* The version ID of the object that you want to place a
|
|
5175
|
+
* The version ID of the object that you want to place a legal hold on.
|
|
4757
5176
|
*/
|
|
4758
5177
|
VersionId?: ObjectVersionId;
|
|
4759
5178
|
/**
|
|
@@ -4761,7 +5180,11 @@ declare namespace S3 {
|
|
|
4761
5180
|
*/
|
|
4762
5181
|
ContentMD5?: ContentMD5;
|
|
4763
5182
|
/**
|
|
4764
|
-
*
|
|
5183
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
|
|
5184
|
+
*/
|
|
5185
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
5186
|
+
/**
|
|
5187
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4765
5188
|
*/
|
|
4766
5189
|
ExpectedBucketOwner?: AccountId;
|
|
4767
5190
|
}
|
|
@@ -4787,19 +5210,39 @@ declare namespace S3 {
|
|
|
4787
5210
|
*/
|
|
4788
5211
|
ContentMD5?: ContentMD5;
|
|
4789
5212
|
/**
|
|
4790
|
-
*
|
|
5213
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
|
|
5214
|
+
*/
|
|
5215
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
5216
|
+
/**
|
|
5217
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4791
5218
|
*/
|
|
4792
5219
|
ExpectedBucketOwner?: AccountId;
|
|
4793
5220
|
}
|
|
4794
5221
|
export interface PutObjectOutput {
|
|
4795
5222
|
/**
|
|
4796
|
-
*
|
|
5223
|
+
* If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL-encoded.
|
|
4797
5224
|
*/
|
|
4798
5225
|
Expiration?: Expiration;
|
|
4799
5226
|
/**
|
|
4800
5227
|
* Entity tag for the uploaded object.
|
|
4801
5228
|
*/
|
|
4802
5229
|
ETag?: ETag;
|
|
5230
|
+
/**
|
|
5231
|
+
* The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
5232
|
+
*/
|
|
5233
|
+
ChecksumCRC32?: ChecksumCRC32;
|
|
5234
|
+
/**
|
|
5235
|
+
* The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
5236
|
+
*/
|
|
5237
|
+
ChecksumCRC32C?: ChecksumCRC32C;
|
|
5238
|
+
/**
|
|
5239
|
+
* The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
5240
|
+
*/
|
|
5241
|
+
ChecksumSHA1?: ChecksumSHA1;
|
|
5242
|
+
/**
|
|
5243
|
+
* The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
5244
|
+
*/
|
|
5245
|
+
ChecksumSHA256?: ChecksumSHA256;
|
|
4803
5246
|
/**
|
|
4804
5247
|
* If you specified server-side encryption either with an Amazon Web Services KMS key or Amazon S3-managed encryption key in your PUT request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.
|
|
4805
5248
|
*/
|
|
@@ -4840,7 +5283,7 @@ declare namespace S3 {
|
|
|
4840
5283
|
*/
|
|
4841
5284
|
Body?: Body;
|
|
4842
5285
|
/**
|
|
4843
|
-
* The bucket name to which the PUT action was initiated. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
5286
|
+
* The bucket name to which the PUT action was initiated. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
4844
5287
|
*/
|
|
4845
5288
|
Bucket: BucketName;
|
|
4846
5289
|
/**
|
|
@@ -4871,6 +5314,26 @@ declare namespace S3 {
|
|
|
4871
5314
|
* A standard MIME type describing the format of the contents. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.
|
|
4872
5315
|
*/
|
|
4873
5316
|
ContentType?: ContentType;
|
|
5317
|
+
/**
|
|
5318
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
|
|
5319
|
+
*/
|
|
5320
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
5321
|
+
/**
|
|
5322
|
+
* This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
|
|
5323
|
+
*/
|
|
5324
|
+
ChecksumCRC32?: ChecksumCRC32;
|
|
5325
|
+
/**
|
|
5326
|
+
* This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
|
|
5327
|
+
*/
|
|
5328
|
+
ChecksumCRC32C?: ChecksumCRC32C;
|
|
5329
|
+
/**
|
|
5330
|
+
* This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
|
|
5331
|
+
*/
|
|
5332
|
+
ChecksumSHA1?: ChecksumSHA1;
|
|
5333
|
+
/**
|
|
5334
|
+
* This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
|
|
5335
|
+
*/
|
|
5336
|
+
ChecksumSHA256?: ChecksumSHA256;
|
|
4874
5337
|
/**
|
|
4875
5338
|
* The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.
|
|
4876
5339
|
*/
|
|
@@ -4953,7 +5416,7 @@ declare namespace S3 {
|
|
|
4953
5416
|
*/
|
|
4954
5417
|
ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus;
|
|
4955
5418
|
/**
|
|
4956
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
5419
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4957
5420
|
*/
|
|
4958
5421
|
ExpectedBucketOwner?: AccountId;
|
|
4959
5422
|
}
|
|
@@ -4987,7 +5450,11 @@ declare namespace S3 {
|
|
|
4987
5450
|
*/
|
|
4988
5451
|
ContentMD5?: ContentMD5;
|
|
4989
5452
|
/**
|
|
4990
|
-
*
|
|
5453
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
|
|
5454
|
+
*/
|
|
5455
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
5456
|
+
/**
|
|
5457
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
4991
5458
|
*/
|
|
4992
5459
|
ExpectedBucketOwner?: AccountId;
|
|
4993
5460
|
}
|
|
@@ -4999,7 +5466,7 @@ declare namespace S3 {
|
|
|
4999
5466
|
}
|
|
5000
5467
|
export interface PutObjectTaggingRequest {
|
|
5001
5468
|
/**
|
|
5002
|
-
* The bucket name containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
5469
|
+
* The bucket name containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
5003
5470
|
*/
|
|
5004
5471
|
Bucket: BucketName;
|
|
5005
5472
|
/**
|
|
@@ -5014,12 +5481,16 @@ declare namespace S3 {
|
|
|
5014
5481
|
* The MD5 hash for the request body. For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
|
|
5015
5482
|
*/
|
|
5016
5483
|
ContentMD5?: ContentMD5;
|
|
5484
|
+
/**
|
|
5485
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
|
|
5486
|
+
*/
|
|
5487
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
5017
5488
|
/**
|
|
5018
5489
|
* Container for the TagSet and Tag elements
|
|
5019
5490
|
*/
|
|
5020
5491
|
Tagging: Tagging;
|
|
5021
5492
|
/**
|
|
5022
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
5493
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
5023
5494
|
*/
|
|
5024
5495
|
ExpectedBucketOwner?: AccountId;
|
|
5025
5496
|
RequestPayer?: RequestPayer;
|
|
@@ -5033,12 +5504,16 @@ declare namespace S3 {
|
|
|
5033
5504
|
* The MD5 hash of the PutPublicAccessBlock request body. For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
|
|
5034
5505
|
*/
|
|
5035
5506
|
ContentMD5?: ContentMD5;
|
|
5507
|
+
/**
|
|
5508
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
|
|
5509
|
+
*/
|
|
5510
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
5036
5511
|
/**
|
|
5037
5512
|
* The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide.
|
|
5038
5513
|
*/
|
|
5039
5514
|
PublicAccessBlockConfiguration: PublicAccessBlockConfiguration;
|
|
5040
5515
|
/**
|
|
5041
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
5516
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
5042
5517
|
*/
|
|
5043
5518
|
ExpectedBucketOwner?: AccountId;
|
|
5044
5519
|
}
|
|
@@ -5240,7 +5715,7 @@ declare namespace S3 {
|
|
|
5240
5715
|
}
|
|
5241
5716
|
export interface RestoreObjectRequest {
|
|
5242
5717
|
/**
|
|
5243
|
-
* The bucket name containing the object to restore. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
5718
|
+
* The bucket name containing the object to restore. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
5244
5719
|
*/
|
|
5245
5720
|
Bucket: BucketName;
|
|
5246
5721
|
/**
|
|
@@ -5254,7 +5729,11 @@ declare namespace S3 {
|
|
|
5254
5729
|
RestoreRequest?: RestoreRequest;
|
|
5255
5730
|
RequestPayer?: RequestPayer;
|
|
5256
5731
|
/**
|
|
5257
|
-
*
|
|
5732
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
|
|
5733
|
+
*/
|
|
5734
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
5735
|
+
/**
|
|
5736
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
5258
5737
|
*/
|
|
5259
5738
|
ExpectedBucketOwner?: AccountId;
|
|
5260
5739
|
}
|
|
@@ -5377,7 +5856,7 @@ declare namespace S3 {
|
|
|
5377
5856
|
}
|
|
5378
5857
|
export interface ScanRange {
|
|
5379
5858
|
/**
|
|
5380
|
-
* Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. If only start is supplied, it means scan from that point to the end of the file.For example
|
|
5859
|
+
* Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. If only start is supplied, it means scan from that point to the end of the file. For example, <scanrange><start>50</start></scanrange> means scan from byte 50 until the end of the file.
|
|
5381
5860
|
*/
|
|
5382
5861
|
Start?: Start;
|
|
5383
5862
|
/**
|
|
@@ -5402,15 +5881,15 @@ declare namespace S3 {
|
|
|
5402
5881
|
*/
|
|
5403
5882
|
Key: ObjectKey;
|
|
5404
5883
|
/**
|
|
5405
|
-
* The SSE
|
|
5884
|
+
* The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
|
|
5406
5885
|
*/
|
|
5407
5886
|
SSECustomerAlgorithm?: SSECustomerAlgorithm;
|
|
5408
5887
|
/**
|
|
5409
|
-
* The SSE
|
|
5888
|
+
* The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
|
|
5410
5889
|
*/
|
|
5411
5890
|
SSECustomerKey?: SSECustomerKey;
|
|
5412
5891
|
/**
|
|
5413
|
-
* The SSE
|
|
5892
|
+
* The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
|
|
5414
5893
|
*/
|
|
5415
5894
|
SSECustomerKeyMD5?: SSECustomerKeyMD5;
|
|
5416
5895
|
/**
|
|
@@ -5438,7 +5917,7 @@ declare namespace S3 {
|
|
|
5438
5917
|
*/
|
|
5439
5918
|
ScanRange?: ScanRange;
|
|
5440
5919
|
/**
|
|
5441
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
5920
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
5442
5921
|
*/
|
|
5443
5922
|
ExpectedBucketOwner?: AccountId;
|
|
5444
5923
|
}
|
|
@@ -5676,11 +6155,11 @@ declare namespace S3 {
|
|
|
5676
6155
|
}
|
|
5677
6156
|
export interface UploadPartCopyRequest {
|
|
5678
6157
|
/**
|
|
5679
|
-
* The bucket name. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
6158
|
+
* The bucket name. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
5680
6159
|
*/
|
|
5681
6160
|
Bucket: BucketName;
|
|
5682
6161
|
/**
|
|
5683
|
-
* Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point: For objects not accessed through an access point, specify the name of the source bucket and key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL
|
|
6162
|
+
* Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point: For objects not accessed through an access point, specify the name of the source bucket and key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL-encoded. For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded. Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region. Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL-encoded. To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.
|
|
5684
6163
|
*/
|
|
5685
6164
|
CopySource: CopySource;
|
|
5686
6165
|
/**
|
|
@@ -5741,11 +6220,11 @@ declare namespace S3 {
|
|
|
5741
6220
|
CopySourceSSECustomerKeyMD5?: CopySourceSSECustomerKeyMD5;
|
|
5742
6221
|
RequestPayer?: RequestPayer;
|
|
5743
6222
|
/**
|
|
5744
|
-
* The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request
|
|
6223
|
+
* The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
5745
6224
|
*/
|
|
5746
6225
|
ExpectedBucketOwner?: AccountId;
|
|
5747
6226
|
/**
|
|
5748
|
-
* The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request
|
|
6227
|
+
* The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
5749
6228
|
*/
|
|
5750
6229
|
ExpectedSourceBucketOwner?: AccountId;
|
|
5751
6230
|
}
|
|
@@ -5758,6 +6237,22 @@ declare namespace S3 {
|
|
|
5758
6237
|
* Entity tag for the uploaded object.
|
|
5759
6238
|
*/
|
|
5760
6239
|
ETag?: ETag;
|
|
6240
|
+
/**
|
|
6241
|
+
* The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
6242
|
+
*/
|
|
6243
|
+
ChecksumCRC32?: ChecksumCRC32;
|
|
6244
|
+
/**
|
|
6245
|
+
* The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
6246
|
+
*/
|
|
6247
|
+
ChecksumCRC32C?: ChecksumCRC32C;
|
|
6248
|
+
/**
|
|
6249
|
+
* The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
6250
|
+
*/
|
|
6251
|
+
ChecksumSHA1?: ChecksumSHA1;
|
|
6252
|
+
/**
|
|
6253
|
+
* The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
|
|
6254
|
+
*/
|
|
6255
|
+
ChecksumSHA256?: ChecksumSHA256;
|
|
5761
6256
|
/**
|
|
5762
6257
|
* If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
|
|
5763
6258
|
*/
|
|
@@ -5782,7 +6277,7 @@ declare namespace S3 {
|
|
|
5782
6277
|
*/
|
|
5783
6278
|
Body?: Body;
|
|
5784
6279
|
/**
|
|
5785
|
-
* The name of the bucket to which the multipart upload was initiated. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
|
|
6280
|
+
* The name of the bucket to which the multipart upload was initiated. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
|
|
5786
6281
|
*/
|
|
5787
6282
|
Bucket: BucketName;
|
|
5788
6283
|
/**
|
|
@@ -5793,6 +6288,26 @@ declare namespace S3 {
|
|
|
5793
6288
|
* The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.
|
|
5794
6289
|
*/
|
|
5795
6290
|
ContentMD5?: ContentMD5;
|
|
6291
|
+
/**
|
|
6292
|
+
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter. This checksum algorithm must be the same for all parts and it match the checksum value supplied in the CreateMultipartUpload request.
|
|
6293
|
+
*/
|
|
6294
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
6295
|
+
/**
|
|
6296
|
+
* This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
|
|
6297
|
+
*/
|
|
6298
|
+
ChecksumCRC32?: ChecksumCRC32;
|
|
6299
|
+
/**
|
|
6300
|
+
* This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
|
|
6301
|
+
*/
|
|
6302
|
+
ChecksumCRC32C?: ChecksumCRC32C;
|
|
6303
|
+
/**
|
|
6304
|
+
* This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
|
|
6305
|
+
*/
|
|
6306
|
+
ChecksumSHA1?: ChecksumSHA1;
|
|
6307
|
+
/**
|
|
6308
|
+
* This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
|
|
6309
|
+
*/
|
|
6310
|
+
ChecksumSHA256?: ChecksumSHA256;
|
|
5796
6311
|
/**
|
|
5797
6312
|
* Object key for which the multipart upload was initiated.
|
|
5798
6313
|
*/
|
|
@@ -5819,7 +6334,7 @@ declare namespace S3 {
|
|
|
5819
6334
|
SSECustomerKeyMD5?: SSECustomerKeyMD5;
|
|
5820
6335
|
RequestPayer?: RequestPayer;
|
|
5821
6336
|
/**
|
|
5822
|
-
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
|
|
6337
|
+
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
|
|
5823
6338
|
*/
|
|
5824
6339
|
ExpectedBucketOwner?: AccountId;
|
|
5825
6340
|
}
|
|
@@ -5874,7 +6389,7 @@ declare namespace S3 {
|
|
|
5874
6389
|
*/
|
|
5875
6390
|
StatusCode?: GetObjectResponseStatusCode;
|
|
5876
6391
|
/**
|
|
5877
|
-
* A string that uniquely identifies an error condition. Returned in the <Code> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in the body. All error codes from S3 are sentence-cased.
|
|
6392
|
+
* A string that uniquely identifies an error condition. Returned in the <Code> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in the body. All error codes from S3 are sentence-cased. The regular expression (regex) value is "^[A-Z][a-zA-Z]+$".
|
|
5878
6393
|
*/
|
|
5879
6394
|
ErrorCode?: ErrorCode;
|
|
5880
6395
|
/**
|
|
@@ -5913,6 +6428,22 @@ declare namespace S3 {
|
|
|
5913
6428
|
* A standard MIME type describing the format of the object data.
|
|
5914
6429
|
*/
|
|
5915
6430
|
ContentType?: ContentType;
|
|
6431
|
+
/**
|
|
6432
|
+
* This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32 checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide. Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
|
|
6433
|
+
*/
|
|
6434
|
+
ChecksumCRC32?: ChecksumCRC32;
|
|
6435
|
+
/**
|
|
6436
|
+
* This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32C checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide. Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
|
|
6437
|
+
*/
|
|
6438
|
+
ChecksumCRC32C?: ChecksumCRC32C;
|
|
6439
|
+
/**
|
|
6440
|
+
* This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 160-bit SHA-1 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide. Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
|
|
6441
|
+
*/
|
|
6442
|
+
ChecksumSHA1?: ChecksumSHA1;
|
|
6443
|
+
/**
|
|
6444
|
+
* This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 256-bit SHA-256 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide. Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
|
|
6445
|
+
*/
|
|
6446
|
+
ChecksumSHA256?: ChecksumSHA256;
|
|
5916
6447
|
/**
|
|
5917
6448
|
* Specifies whether an object stored in Amazon S3 is (true) or is not (false) a delete marker.
|
|
5918
6449
|
*/
|
|
@@ -5926,7 +6457,7 @@ declare namespace S3 {
|
|
|
5926
6457
|
*/
|
|
5927
6458
|
Expires?: Expires;
|
|
5928
6459
|
/**
|
|
5929
|
-
* If object
|
|
6460
|
+
* If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide the object expiration information. The value of the rule-id is URL-encoded.
|
|
5930
6461
|
*/
|
|
5931
6462
|
Expiration?: Expiration;
|
|
5932
6463
|
/**
|
|
@@ -5983,7 +6514,7 @@ declare namespace S3 {
|
|
|
5983
6514
|
*/
|
|
5984
6515
|
SSECustomerKeyMD5?: SSECustomerKeyMD5;
|
|
5985
6516
|
/**
|
|
5986
|
-
*
|
|
6517
|
+
* Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects. For more information, see Storage Classes.
|
|
5987
6518
|
*/
|
|
5988
6519
|
StorageClass?: StorageClass;
|
|
5989
6520
|
/**
|