S3 - Boto 3 Docs 1.9.249 Documentation PDF

Boto 3 Docs 1.9.
249
Docs (../../index.html) / Available Services (index.html) / S3
documentation (
../../index.html)
TABLE OF CONTENTS
S3
Quickstart
(../../guide/quickstart.html)
A Sample Tutorial
(../../guide/sqs.html)
Code Examples
(../../guide/examples.html)
User Guides
(../../guide/index.html)
Available Services (index.html)
ACM (acm.html)
ACMPCA (acm-pca.html)
AlexaForBusiness
(alexaforbusiness.html)
Amplify (amplify.html)
APIGateway
(apigateway.html)
ApiGatewayManagement
Api
(apigatewaymanagement
api.html)
Boto 3 Docs 1.9.249
documentation ( Table of Contents
../../index.html) S3
Client
TABLE OF CONTENTS Paginators
Waiters
Quickstart Service Resource
Bucket
A Sample Tutorial BucketAcl
(../../guide/sqs.html) BucketCors
Code Examples BucketLifecycle
(../../guide/examples.html) BucketLifecycleConfiguration
BucketLogging
User Guides
BucketNotification
BucketPolicy
Available Services (index.html) BucketRequestPayment
BucketTagging
ACM (acm.html)
BucketVersioning
ACMPCA (acm-pca.html) BucketWebsite
AlexaForBusiness MultipartUpload
(alexaforbusiness.html) MultipartUploadPart
Amplify (amplify.html) Object
ObjectAcl
APIGateway
ObjectSummary
(apigateway.html)
ObjectVersion
ApiGatewayManagement Examples
Api
api.html)
Boto 3 Docs 1.9.249
documentation (
Client
../../index.html) class S3. Client
A low-level client representing Amazon Simple Storage Service (S3):
TABLE OF CONTENTS
import boto3
Quickstart
client = boto3.client('s3')
A Sample Tutorial
These are the available methods:
Code Examples
(../../guide/examples.html) abort_multipart_upload()
can_paginate()
User Guides
complete_multipart_upload()
copy()
Available Services (index.html) copy_object()
create_bucket()
ACM (acm.html)
create_multipart_upload()
ACMPCA (acm-pca.html) delete_bucket()
delete_bucket_analytics_configuration()
AlexaForBusiness
(alexaforbusiness.html) delete_bucket_cors()
delete_bucket_encryption()
Amplify (amplify.html) delete_bucket_inventory_configuration()
APIGateway delete_bucket_lifecycle()
(apigateway.html) delete_bucket_metrics_configuration()
delete_bucket_policy()
delete_bucket_replication()
Api
delete_bucket_tagging()
api.html) delete_bucket_website()
delete_object()
Boto 3 Docs 1.9.249
delete_object_tagging()
documentation ( delete_objects()
../../index.html) delete_public_access_block()
download_file()
TABLE OF CONTENTS download_fileobj()
generate_presigned_post()
Quickstart generate_presigned_url()
(../../guide/quickstart.html) get_bucket_accelerate_configuration()
get_bucket_acl()
A Sample Tutorial
(../../guide/sqs.html) get_bucket_analytics_configuration()
get_bucket_cors()
Code Examples get_bucket_encryption()
get_bucket_inventory_configuration()
User Guides get_bucket_lifecycle()
(../../guide/index.html) get_bucket_lifecycle_configuration()
get_bucket_location()
Available Services (index.html) get_bucket_logging()
ACM (acm.html) get_bucket_metrics_configuration()
get_bucket_notification()
get_bucket_notification_configuration()
AlexaForBusiness get_bucket_policy()
(alexaforbusiness.html) get_bucket_policy_status()
Amplify (amplify.html) get_bucket_replication()
get_bucket_request_payment()
APIGateway
get_bucket_tagging()
(apigateway.html)
get_bucket_versioning()
ApiGatewayManagement get_bucket_website()
Api get_object()
(apigatewaymanagement get_object_acl()
api.html) get_object_legal_hold()
get_object_lock_configuration()
Boto 3 Docs 1.9.249
get_object_retention()
documentation ( get_object_tagging()
../../index.html) get_object_torrent()
get_paginator()
TABLE OF CONTENTS get_public_access_block()
get_waiter()
Quickstart head_bucket()
(../../guide/quickstart.html) head_object()
list_bucket_analytics_configurations()
A Sample Tutorial
(../../guide/sqs.html) list_bucket_inventory_configurations()
list_bucket_metrics_configurations()
Code Examples list_buckets()
list_multipart_uploads()
User Guides list_object_versions()
(../../guide/index.html) list_objects()
list_objects_v2()
Available Services (index.html) list_parts()
ACM (acm.html) put_bucket_accelerate_configuration()
put_bucket_acl()
put_bucket_analytics_configuration()
AlexaForBusiness put_bucket_cors()
(alexaforbusiness.html) put_bucket_encryption()
Amplify (amplify.html) put_bucket_inventory_configuration()
put_bucket_lifecycle()
APIGateway
put_bucket_lifecycle_configuration()
(apigateway.html)
put_bucket_logging()
ApiGatewayManagement put_bucket_metrics_configuration()
Api put_bucket_notification()
(apigatewaymanagement put_bucket_notification_configuration()
api.html) put_bucket_policy()
put_bucket_replication()
Boto 3 Docs 1.9.249
put_bucket_request_payment()
documentation ( put_bucket_tagging()
../../index.html) put_bucket_versioning()
put_bucket_website()
TABLE OF CONTENTS put_object()
put_object_acl()
Quickstart put_object_legal_hold()
(../../guide/quickstart.html) put_object_lock_configuration()
put_object_retention()
A Sample Tutorial
(../../guide/sqs.html) put_object_tagging()
put_public_access_block()
Code Examples restore_object()
select_object_content()
User Guides upload_file()
(../../guide/index.html) upload_fileobj()
upload_part()
Available Services (index.html) upload_part_copy()
ACM (acm.html)
abort_multipart_upload (**kwargs)
ACMPCA (acm-pca.html) Aborts a multipart upload.
AlexaForBusiness To verify that all parts have been removed, so you don't get charged for the
(alexaforbusiness.html) part storage, you should call the List Parts operation and ensure the parts list is
Amplify (amplify.html) empty.
APIGateway See also: AWS API Documentation

(apigateway.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-
01/AbortMultipartUpload)
Api Request Syntax
api.html)
Boto 3 Docs 1.9.249 response = client.abort_multipart_upload(
documentation ( Bucket='string',
../../index.html) Key='string',
UploadId='string',
RequestPayer='requester'
TABLE OF CONTENTS
)
Quickstart
(../../guide/quickstart.html) Parameters
A Sample Tutorial Bucket (string) --
(../../guide/sqs.html) [REQUIRED]
Code Examples Name of the bucket to which the multipart upload was initiated.
(../../guide/examples.html) Key (string) --
[REQUIRED]
User Guides
(../../guide/index.html) Key of the object for which the multipart upload was initiated.
Available Services (index.html) UploadId (string) --

[REQUIRED]
ACM (acm.html)
Upload ID that identifies the multipart upload.
RequestPayer (string) -- Confirms that the requester knows that she or
AlexaForBusiness
he will be charged for the request. Bucket owners need not specify this
parameter in their requests. Documentation on downloading objects
Amplify (amplify.html) from requester pays buckets can be found at
http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
APIGateway
(http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
(apigateway.html)
Return type
Api dict
(apigatewaymanagement Returns
api.html)
Response Syntax
Boto 3 Docs 1.9.249
documentation (
{
../../index.html)
'RequestCharged': 'requester'
}
TABLE OF CONTENTS
Quickstart Response Structure

(dict) --
A Sample Tutorial
RequestCharged (string) --
If present, indicates that the requester was successfully charged for the
Code Examples
request.
User Guides
(../../guide/index.html) can_paginate (operation_name)
Check if an operation can be paginated.
Parameters
ACM (acm.html)
operation_name (string) -- The operation name. This is the same name as
ACMPCA (acm-pca.html) the method name on the client. For example, if the method name is
create_foo , and you'd normally invoke the operation as
AlexaForBusiness
client.create_foo(**kwargs) , if the create_foo operation can be
paginated, you can use the call client.get_paginator("create_foo") .
Returns
APIGateway
True if the operation can be paginated, False otherwise.
(apigateway.html)
Api complete_multipart_upload (**kwargs)
(apigatewaymanagement Completes a multipart upload by assembling previously uploaded parts.
api.html)
See also: AWS API Documentation
Boto 3 Docs 1.9.249
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-
documentation ( 01/CompleteMultipartUpload)
../../index.html)
Request Syntax
TABLE OF CONTENTS
response = client.complete_multipart_upload(
Quickstart Bucket='string',
(../../guide/quickstart.html) Key='string',
MultipartUpload={
A Sample Tutorial
'Parts': [
{
Code Examples 'ETag': 'string',
(../../guide/examples.html) 'PartNumber': 123
},
User Guides
]
},
Available Services (index.html) UploadId='string',
ACM (acm.html)
)
AlexaForBusiness Parameters
Bucket (string) -- [REQUIRED]
Amplify (amplify.html) Key (string) -- [REQUIRED]
MultipartUpload (dict) --
APIGateway
Parts (list) --
(apigateway.html)
(dict) --
ApiGatewayManagement ETag (string) --
Api Entity tag returned when the part was uploaded.
PartNumber (integer) --
api.html)
Part number that identifies the part. This is a positive integer
Boto 3 Docs 1.9.249
between 1 and 10,000.
documentation (
UploadId (string) -- [REQUIRED]
../../index.html)
TABLE OF CONTENTS parameter in their requests. Documentation on downloading objects
from requester pays buckets can be found at
Quickstart http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
(../../guide/quickstart.html) (http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
A Sample Tutorial Return type
(../../guide/sqs.html) dict
Code Examples Returns
Response Syntax
User Guides
{
Available Services (index.html) 'Location': 'string',
'Bucket': 'string',
ACM (acm.html)
'Key': 'string',
ACMPCA (acm-pca.html) 'Expiration': 'string',
AlexaForBusiness 'ETag': 'string',
(alexaforbusiness.html) 'ServerSideEncryption': 'AES256'|'aws:kms',
'VersionId': 'string',
'SSEKMSKeyId': 'string',
APIGateway 'RequestCharged': 'requester'
(apigateway.html) }
Api Response Structure
api.html) (dict) --
Location (string) --
Boto 3 Docs 1.9.249
documentation ( Bucket (string) --
../../index.html) Key (string) --

Expiration (string) --
TABLE OF CONTENTS
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
Quickstart
encoded.
ETag (string) --
A Sample Tutorial
(../../guide/sqs.html) Entity tag of the object.
Code Examples ServerSideEncryption (string) --

The Server-side encryption algorithm used when storing this object in
User Guides S3 (e.g., AES256, aws:kms).
(../../guide/index.html) VersionId (string) --
Available Services (index.html) Version of the object.
ACM (acm.html) SSEKMSKeyId (string) --
ACMPCA (acm-pca.html) If present, specifies the ID of the AWS Key Management Service (KMS)
master encryption key that was used for the object.
AlexaForBusiness
(alexaforbusiness.html) RequestCharged (string) --
Amplify (amplify.html) If present, indicates that the requester was successfully charged for the
request.
APIGateway
(apigateway.html)
ApiGatewayManagement copy (CopySource, Bucket, Key, ExtraArgs=None, Callback=None,

Api
SourceClient=None, Config=None)
Copy an object from one S3 location to another.
api.html)
This is a managed transfer which will perform a multipart copy in multiple
Boto 3 Docs 1.9.249
threads if necessary.
documentation (
Usage:
../../index.html)
TABLE OF CONTENTS import boto3

s3 = boto3.resource('s3')
Quickstart copy_source = {
(../../guide/quickstart.html) 'Bucket': 'mybucket',
'Key': 'mykey'
A Sample Tutorial
}
s3.meta.client.copy(copy_source, 'otherbucket', 'otherkey')
Code Examples
Parameters
User Guides CopySource (dict) -- The name of the source bucket, key name of the
(../../guide/index.html) source object, and optional version ID of the source object. The dictionary
format is: {'Bucket': 'bucket', 'Key': 'key', 'VersionId': 'id'} .
Note that the VersionId key is optional and may be omitted.
ACM (acm.html) Bucket (str) -- The name of the bucket to copy to
ACMPCA (acm-pca.html) Key (str) -- The name of the key to copy to
ExtraArgs (dict) -- Extra arguments that may be passed to the client
AlexaForBusiness operation
(alexaforbusiness.html) Callback (function) -- A method which takes a number of bytes
Amplify (amplify.html) transferred to be periodically called during the copy.
SourceClient (botocore or boto3 Client) -- The client to be used for
APIGateway operation that may happen at the source object. For example, this client
(apigateway.html) is used for the head_object that determines the size of the copy. If no
ApiGatewayManagement client is provided, the current client is used as the client for the source
Api object.
(apigatewaymanagement Config (boto3.s3.transfer.TransferConfig
api.html) (../customizations/s3.html#boto3.s3.transfer.TransferConfig)) -- The
transfer configuration to be used when performing the copy.
Boto 3 Docs 1.9.249
documentation (
../../index.html) copy_object (**kwargs)
Creates a copy of an object that is already stored in Amazon S3.
TABLE OF CONTENTS
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CopyObject)
Quickstart
(../../guide/quickstart.html) Request Syntax
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.copy_object(
documentation ( ACL='private'|'public-read'|'public-read-write'|'authenticated-rea
../../index.html) Bucket='string',
CacheControl='string',
ContentDisposition='string',
TABLE OF CONTENTS
ContentEncoding='string',
ContentLanguage='string',
Quickstart
ContentType='string',
CopySource='string' or {'Bucket': 'string', 'Key': 'string', 'Vers
A Sample Tutorial CopySourceIfMatch='string',
(../../guide/sqs.html) CopySourceIfModifiedSince=datetime(2015, 1, 1),
Code Examples CopySourceIfNoneMatch='string',
(../../guide/examples.html) CopySourceIfUnmodifiedSince=datetime(2015, 1, 1),
Expires=datetime(2015, 1, 1),
User Guides
GrantFullControl='string',
GrantRead='string',
Available Services (index.html) GrantReadACP='string',
GrantWriteACP='string',
ACM (acm.html)
Key='string',
ACMPCA (acm-pca.html) Metadata={
'string': 'string'
AlexaForBusiness
(alexaforbusiness.html) },
MetadataDirective='COPY'|'REPLACE',
Amplify (amplify.html) TaggingDirective='COPY'|'REPLACE',
APIGateway ServerSideEncryption='AES256'|'aws:kms',
(apigateway.html) StorageClass='STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|'ONEZON
WebsiteRedirectLocation='string',
SSECustomerAlgorithm='string',
Api
SSECustomerKey='string',
api.html) SSEKMSKeyId='string',
SSEKMSEncryptionContext='string',
Boto 3 Docs 1.9.249
CopySourceSSECustomerAlgorithm='string',
documentation ( CopySourceSSECustomerKey='string',
../../index.html) RequestPayer='requester',
Tagging='string',
TABLE OF CONTENTS ObjectLockMode='GOVERNANCE'|'COMPLIANCE',
ObjectLockRetainUntilDate=datetime(2015, 1, 1),
Quickstart ObjectLockLegalHoldStatus='ON'|'OFF'
(../../guide/quickstart.html) )
A Sample Tutorial
Parameters
Code Examples
ACL (string) -- The canned ACL to apply to the object.
User Guides CacheControl (string) -- Specifies caching behavior along the
(../../guide/index.html) request/reply chain.
ContentDisposition (string) -- Specifies presentational information for
the object.
ACM (acm.html) ContentEncoding (string) -- Specifies what content encodings have been
applied to the object and thus what decoding mechanisms must be
applied to obtain the media-type referenced by the Content-Type header
AlexaForBusiness field.
(alexaforbusiness.html) ContentLanguage (string) -- The language the content is in.
ContentType (string) -- A standard MIME type describing the format of
the object data.
APIGateway CopySource (str or dict) -- [REQUIRED] The name of the source bucket,
(apigateway.html) key name of the source object, and optional version ID of the source
object. You can either provide this value as a string or a dictionary. The
string form is {bucket}/{key} or {bucket}/{key}?versionId={versionId} if
Api
you want to copy a specific version. You can also provide this value as a
dictionary. The dictionary format is recommended over the string format
api.html)
because it is more explicit. The dictionary format is: {'Bucket': 'bucket',
Boto 3 Docs 1.9.249
'Key': 'key', 'VersionId': 'id'}. Note that the VersionId key is optional and
documentation ( may be omitted.
../../index.html) CopySourceIfMatch (string) -- Copies the object if its entity tag (ETag)
matches the specified tag.
TABLE OF CONTENTS CopySourceIfModifiedSince (datetime) -- Copies the object if it has been
modified since the specified time.
Quickstart CopySourceIfNoneMatch (string) -- Copies the object if its entity tag
(../../guide/quickstart.html) (ETag) is different than the specified ETag.
CopySourceIfUnmodifiedSince (datetime) -- Copies the object if it hasn't
A Sample Tutorial been modified since the specified time.
(../../guide/sqs.html) Expires (datetime) -- The date and time at which the object is no longer
Code Examples cacheable.
(../../guide/examples.html) GrantFullControl (string) -- Gives the grantee READ, READ_ACP, and
WRITE_ACP permissions on the object.
User Guides GrantRead (string) -- Allows grantee to read the object data and its
(../../guide/index.html) metadata.
GrantReadACP (string) -- Allows grantee to read the object ACL.
GrantWriteACP (string) -- Allows grantee to write the ACL for the
ACM (acm.html) applicable object.
Key (string) -- [REQUIRED]
Metadata (dict) --
AlexaForBusiness A map of metadata to store with the object in S3.
(string) --
Amplify (amplify.html) (string) --
APIGateway MetadataDirective (string) -- Specifies whether the metadata is copied
(apigateway.html) from the source object or replaced with metadata provided in the
request.
ApiGatewayManagement TaggingDirective (string) -- Specifies whether the object tag-set are
Api copied from the source object or replaced with tag-set provided in the
(apigatewaymanagement request.
api.html)
ServerSideEncryption (string) -- The Server-side encryption algorithm
Boto 3 Docs 1.9.249
used when storing this object in S3 (e.g., AES256, aws:kms).
documentation ( StorageClass (string) -- The type of storage to use for the object. Defaults
../../index.html) to 'STANDARD'.
WebsiteRedirectLocation (string) -- If the bucket is configured as a
TABLE OF CONTENTS website, redirects requests for this object to another object in the same
bucket or to an external URL. Amazon S3 stores the value of this header
Quickstart in the object metadata.
(../../guide/quickstart.html) SSECustomerAlgorithm (string) -- Specifies the algorithm to use to when
encrypting the object (e.g., AES256).
A Sample Tutorial SSECustomerKey (string) -- Specifies the customer-provided encryption
(../../guide/sqs.html) key for Amazon S3 to use in encrypting data. This value is used to store
Code Examples the object and then it is discarded; Amazon does not store the encryption
(../../guide/examples.html) key. The key must be appropriate for use with the algorithm specified in
the x-amz-server-side-encryption-customer-algorithm header.
User Guides SSECustomerKeyMD5 (string) --
(../../guide/index.html) 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 the encryption key was transmitted without error.
ACM (acm.html)
ACMPCA (acm-pca.html) Please note that this parameter is automatically populated if it is not
AlexaForBusiness provided. Including this parameter is not required
Amplify (amplify.html) SSEKMSKeyId (string) -- Specifies the AWS KMS key ID to use for object
encryption. All GET and PUT requests for an object protected by AWS KMS
APIGateway
will fail if not made via SSL or using SigV4. Documentation on configuring
(apigateway.html)
any of the officially supported AWS SDKs and CLI can be found at
ApiGatewayManagement http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-
Api signature-version
(apigatewaymanagement (http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify
api.html) signature-version)
SSEKMSEncryptionContext (string) -- Specifies the AWS KMS Encryption
Boto 3 Docs 1.9.249
Context to use for object encryption. The value of this header is a base64-
documentation ( encoded UTF-8 string holding JSON with the encryption context key-value
../../index.html) pairs.
CopySourceSSECustomerAlgorithm (string) -- Specifies the algorithm to
TABLE OF CONTENTS use when decrypting the source object (e.g., AES256).
CopySourceSSECustomerKey (string) -- Specifies the customer-provided
Quickstart encryption key for Amazon S3 to use to decrypt the source object. The
(../../guide/quickstart.html) encryption key provided in this header must be one that was used when
the source object was created.
A Sample Tutorial CopySourceSSECustomerKeyMD5 (string) --
(../../guide/sqs.html) Specifies the 128-bit MD5 digest of the encryption key according to RFC
Code Examples 1321. Amazon S3 uses this header for a message integrity check to
(../../guide/examples.html) ensure the encryption key was transmitted without error.
User Guides
(../../guide/index.html) Please note that this parameter is automatically populated if it is not
provided. Including this parameter is not required
ACM (acm.html)
ACMPCA (acm-pca.html) he will be charged for the request. Bucket owners need not specify this
AlexaForBusiness
Amplify (amplify.html) (http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
Tagging (string) -- The tag-set for the object destination object this value
APIGateway
must be used in conjunction with the TaggingDirective. The tag-set must
(apigateway.html)
be encoded as URL Query parameters
ApiGatewayManagement ObjectLockMode (string) -- The object lock mode that you want to apply
Api to the copied object.
(apigatewaymanagement ObjectLockRetainUntilDate (datetime) -- The date and time when you
api.html) want the copied object's object lock to expire.
ObjectLockLegalHoldStatus (string) -- Specifies whether you want to
Boto 3 Docs 1.9.249
apply a Legal Hold to the copied object.
documentation (
Return type
../../index.html)
dict
TABLE OF CONTENTS Returns
Response Syntax
Quickstart
{
A Sample Tutorial 'CopyObjectResult': {
(../../guide/sqs.html) 'ETag': 'string',
Code Examples 'LastModified': datetime(2015, 1, 1)
(../../guide/examples.html) },
'Expiration': 'string',
User Guides
'CopySourceVersionId': 'string',
Available Services (index.html) 'ServerSideEncryption': 'AES256'|'aws:kms',
'SSECustomerAlgorithm': 'string',
ACM (acm.html)
'SSECustomerKeyMD5': 'string',
ACMPCA (acm-pca.html) 'SSEKMSKeyId': 'string',
AlexaForBusiness 'SSEKMSEncryptionContext': 'string',

(alexaforbusiness.html) 'RequestCharged': 'requester'
}
APIGateway
Response Structure
(apigateway.html)
(dict) --
Api CopyObjectResult (dict) --
ETag (string) --
api.html)
LastModified (datetime) --
Boto 3 Docs 1.9.249
documentation (
If the object expiration is configured, the response includes this
../../index.html)
header.
TABLE OF CONTENTS CopySourceVersionId (string) --
VersionId (string) --
Quickstart
Version ID of the newly created copy.
ServerSideEncryption (string) --
A Sample Tutorial
(../../guide/sqs.html) The Server-side encryption algorithm used when storing this object in
S3 (e.g., AES256, aws:kms).
Code Examples
(../../guide/examples.html) SSECustomerAlgorithm (string) --
User Guides If server-side encryption with a customer-provided encryption key was

(../../guide/index.html) requested, the response will include this header confirming the
encryption algorithm used.
SSECustomerKeyMD5 (string) --
ACM (acm.html)
If server-side encryption with a customer-provided encryption key was
ACMPCA (acm-pca.html) requested, the response will include this header to provide round trip
AlexaForBusiness message integrity verification of the customer-provided encryption key.
(alexaforbusiness.html) SSEKMSKeyId (string) --
Amplify (amplify.html) If present, specifies the ID of the AWS Key Management Service (KMS)
APIGateway master encryption key that was used for the object.
(apigateway.html) SSEKMSEncryptionContext (string) --
ApiGatewayManagement If present, specifies the AWS KMS Encryption Context to use for object
Api encryption. The value of this header is a base64-encoded UTF-8 string
(apigatewaymanagement holding JSON with the encryption context key-value pairs.
api.html)
Boto 3 Docs 1.9.249
documentation ( If present, indicates that the requester was successfully charged for the
request.
../../index.html)
TABLE OF CONTENTS
create_bucket (**kwargs)
Creates a new bucket.
Quickstart
(../../guide/quickstart.html) See also: AWS API Documentation
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateBucket)
A Sample Tutorial
(../../guide/sqs.html) Request Syntax
Code Examples
(../../guide/examples.html) response = client.create_bucket(
ACL='private'|'public-read'|'public-read-write'|'authenticated-rea
User Guides Bucket='string',
CreateBucketConfiguration={
Available Services (index.html) 'LocationConstraint': 'EU'|'eu-west-1'|'us-west-1'|'us-west-2'
},
ACM (acm.html)
ACMPCA (acm-pca.html) GrantRead='string',
GrantReadACP='string',
AlexaForBusiness
GrantWrite='string',
Amplify (amplify.html) ObjectLockEnabledForBucket=True|False
APIGateway )
(apigateway.html)
Api Parameters
(apigatewaymanagement ACL (string) -- The canned ACL to apply to the bucket.
api.html) Bucket (string) -- [REQUIRED]
CreateBucketConfiguration (dict) --
Boto 3 Docs 1.9.249
LocationConstraint (string) --
documentation ( Specifies the region where the bucket will be created. If you don't
../../index.html) specify a region, the bucket is created in US East (N. Virginia) Region
(us-east-1).
TABLE OF CONTENTS GrantFullControl (string) -- Allows grantee the read, write, read ACP, and
write ACP permissions on the bucket.
Quickstart GrantRead (string) -- Allows grantee to list the objects in the bucket.
(../../guide/quickstart.html) GrantReadACP (string) -- Allows grantee to read the bucket ACL.
A Sample Tutorial GrantWrite (string) -- Allows grantee to create, overwrite, and delete any
(../../guide/sqs.html) object in the bucket.
Code Examples applicable bucket.
(../../guide/examples.html) ObjectLockEnabledForBucket (boolean) -- Specifies whether you want
Amazon S3 object lock to be enabled for the new bucket.
User Guides
(../../guide/index.html) Return type
dict
Returns
ACM (acm.html)
Response Syntax
AlexaForBusiness
{
'Location': 'string'
Amplify (amplify.html) }
APIGateway
(apigateway.html)
Response Structure
(dict) --
Api
api.html)
Boto 3 Docs 1.9.249 create_multipart_upload (**kwargs)
documentation ( Initiates a multipart upload and returns an upload ID.
../../index.html)
Note: After you initiate multipart upload and upload one or more parts,
TABLE OF CONTENTS you must either complete or abort multipart upload in order to stop
getting charged for storage of the uploaded parts. Only after you either
Quickstart complete or abort multipart upload, Amazon S3 frees up the parts storage
(../../guide/quickstart.html) and stops charging you for the parts storage.
A Sample Tutorial
(../../guide/sqs.html) See also: AWS API Documentation
Code Examples
01/CreateMultipartUpload)
Request Syntax
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.create_multipart_upload(
TABLE OF CONTENTS
Quickstart
A Sample Tutorial GrantFullControl='string',
(../../guide/sqs.html) GrantRead='string',
Code Examples GrantReadACP='string',
(../../guide/examples.html) GrantWriteACP='string',
Key='string',
User Guides
Metadata={
'string': 'string'
Available Services (index.html) },
ServerSideEncryption='AES256'|'aws:kms',
ACM (acm.html)
StorageClass='STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|'ONEZON
ACMPCA (acm-pca.html) WebsiteRedirectLocation='string',
AlexaForBusiness
(alexaforbusiness.html) SSECustomerKey='string',
SSEKMSKeyId='string',
Amplify (amplify.html) SSEKMSEncryptionContext='string',
APIGateway RequestPayer='requester',
(apigateway.html) Tagging='string',
ObjectLockMode='GOVERNANCE'|'COMPLIANCE',
Api
ObjectLockLegalHoldStatus='ON'|'OFF'
api.html) )
Boto 3 Docs 1.9.249
documentation ( Parameters
../../index.html) ACL (string) -- The canned ACL to apply to the object.
TABLE OF CONTENTS
CacheControl (string) -- Specifies caching behavior along the
request/reply chain.
Quickstart
the object.
ContentEncoding (string) -- Specifies what content encodings have been
A Sample Tutorial applied to the object and thus what decoding mechanisms must be
(../../guide/sqs.html) applied to obtain the media-type referenced by the Content-Type header
field.
Code Examples
ContentLanguage (string) -- The language the content is in.
User Guides the object data.
(../../guide/index.html) Expires (datetime) -- The date and time at which the object is no longer
cacheable.
GrantFullControl (string) -- Gives the grantee READ, READ_ACP, and
ACM (acm.html) WRITE_ACP permissions on the object.
GrantRead (string) -- Allows grantee to read the object data and its
metadata.
AlexaForBusiness GrantReadACP (string) -- Allows grantee to read the object ACL.
(alexaforbusiness.html) GrantWriteACP (string) -- Allows grantee to write the ACL for the
applicable object.
APIGateway Metadata (dict) --
(apigateway.html) A map of metadata to store with the object in S3.
ApiGatewayManagement (string) --
Api (string) --
(apigatewaymanagement ServerSideEncryption (string) -- The Server-side encryption algorithm
api.html) used when storing this object in S3 (e.g., AES256, aws:kms).
StorageClass (string) -- The type of storage to use for the object. Defaults
Boto 3 Docs 1.9.249
to 'STANDARD'.
documentation ( WebsiteRedirectLocation (string) -- If the bucket is configured as a
../../index.html) website, redirects requests for this object to another object in the same
TABLE OF CONTENTS in the object metadata.
SSECustomerAlgorithm (string) -- Specifies the algorithm to use to when
Quickstart encrypting the object (e.g., AES256).
(../../guide/quickstart.html) SSECustomerKey (string) -- Specifies the customer-provided encryption
key for Amazon S3 to use in encrypting data. This value is used to store
A Sample Tutorial the object and then it is discarded; Amazon does not store the encryption
(../../guide/sqs.html) key. The key must be appropriate for use with the algorithm specified in
Code Examples the x-amz-server-side-encryption-customer-algorithm header.
(../../guide/examples.html) SSECustomerKeyMD5 (string) --
Specifies the 128-bit MD5 digest of the encryption key according to RFC
User Guides 1321. Amazon S3 uses this header for a message integrity check to
(../../guide/index.html) ensure the encryption key was transmitted without error.
ACM (acm.html) Please note that this parameter is automatically populated if it is not
AlexaForBusiness
SSEKMSKeyId (string) -- Specifies the AWS KMS key ID to use for object
Amplify (amplify.html) will fail if not made via SSL or using SigV4. Documentation on configuring
APIGateway
http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-
(apigateway.html)
signature-version
ApiGatewayManagement (http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify
Api signature-version)
(apigatewaymanagement SSEKMSEncryptionContext (string) -- Specifies the AWS KMS Encryption
api.html) Context to use for object encryption. The value of this header is a base64-
encoded UTF-8 string holding JSON with the encryption context key-value
Boto 3 Docs 1.9.249
pairs.
documentation ( RequestPayer (string) -- Confirms that the requester knows that she or
../../index.html) he will be charged for the request. Bucket owners need not specify this
TABLE OF CONTENTS from requester pays buckets can be found at
Quickstart (http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
(../../guide/quickstart.html) Tagging (string) -- The tag-set for the object. The tag-set must be encoded
as URL Query parameters
A Sample Tutorial ObjectLockMode (string) -- Specifies the object lock mode that you want
(../../guide/sqs.html) to apply to the uploaded object.
Code Examples ObjectLockRetainUntilDate (datetime) -- Specifies the date and time
(../../guide/examples.html) when you want the object lock to expire.
ObjectLockLegalHoldStatus (string) -- Specifies whether you want to
User Guides apply a Legal Hold to the uploaded object.
Return type
Available Services (index.html) dict
ACM (acm.html) Returns
ACMPCA (acm-pca.html) Response Syntax
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'AbortDate': datetime(2015, 1, 1),
../../index.html) 'AbortRuleId': 'string',
'Bucket': 'string',
'Key': 'string',
TABLE OF CONTENTS
'UploadId': 'string',
'ServerSideEncryption': 'AES256'|'aws:kms',
Quickstart
A Sample Tutorial 'SSEKMSKeyId': 'string',
(../../guide/sqs.html) 'SSEKMSEncryptionContext': 'string',
Code Examples 'RequestCharged': 'requester'
(../../guide/examples.html) }
User Guides
(../../guide/index.html) Response Structure
Available Services (index.html) (dict) --
ACM (acm.html) AbortDate (datetime) --
ACMPCA (acm-pca.html) Date when multipart upload will become eligible for abort operation by
lifecycle.
AlexaForBusiness
(alexaforbusiness.html) AbortRuleId (string) --
Amplify (amplify.html) Id of the lifecycle rule that makes a multipart upload eligible for abort
operation.
APIGateway
(apigateway.html) Bucket (string) --
ApiGatewayManagement Name of the bucket to which the multipart upload was initiated.
Api Key (string) --
api.html)
Object key for which the multipart upload was initiated.
UploadId (string) --
Boto 3 Docs 1.9.249
documentation ( ID for the initiated multipart upload.
../../index.html) ServerSideEncryption (string) --

TABLE OF CONTENTS S3 (e.g., AES256, aws:kms).
SSECustomerAlgorithm (string) --
Quickstart
(../../guide/quickstart.html) If server-side encryption with a customer-provided encryption key was
requested, the response will include this header confirming the
A Sample Tutorial
Code Examples
(../../guide/examples.html) If server-side encryption with a customer-provided encryption key was
requested, the response will include this header to provide round trip
User Guides message integrity verification of the customer-provided encryption key.
SSEKMSKeyId (string) --
If present, specifies the ID of the AWS Key Management Service (KMS)
ACM (acm.html) master encryption key that was used for the object.
ACMPCA (acm-pca.html) SSEKMSEncryptionContext (string) --
AlexaForBusiness If present, specifies the AWS KMS Encryption Context to use for object
(alexaforbusiness.html) encryption. The value of this header is a base64-encoded UTF-8 string
Amplify (amplify.html) holding JSON with the encryption context key-value pairs.
APIGateway RequestCharged (string) --

(apigateway.html) If present, indicates that the requester was successfully charged for the
ApiGatewayManagement request.
Api
api.html) delete_bucket (**kwargs)
Deletes the bucket. All objects (including all object versions and Delete Markers)
Boto 3 Docs 1.9.249
in the bucket must be deleted before the bucket itself can be deleted.
documentation (
../../index.html)
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucket)
TABLE OF CONTENTS Request Syntax
Quickstart response = client.delete_bucket(

(../../guide/quickstart.html) Bucket='string'
A Sample Tutorial )
Code Examples Parameters

(../../guide/examples.html) Bucket (string) -- [REQUIRED]
User Guides Returns

(../../guide/index.html) None
ACM (acm.html) delete_bucket_analytics_configuration (**kwargs)
ACMPCA (acm-pca.html) Deletes an analytics configuration for the bucket (specified by the analytics
configuration ID).
AlexaForBusiness
(alexaforbusiness.html) To use this operation, you must have permissions to perform the
s3:PutAnalyticsConfiguration action. The bucket owner has this permission by
Amplify (amplify.html) default. The bucket owner can grant this permission to others.
ApiGatewayManagement 01/DeleteBucketAnalyticsConfiguration)
Api Request Syntax
api.html)
Boto 3 Docs 1.9.249 response = client.delete_bucket_analytics_configuration(
../../index.html) Id='string'
)
TABLE OF CONTENTS
Parameters
Quickstart Bucket (string) --
(../../guide/quickstart.html) [REQUIRED]
A Sample Tutorial The name of the bucket from which an analytics configuration is deleted.
Id (string) --
Code Examples [REQUIRED]
The ID that identifies the analytics configuration.
User Guides
Returns
None
ACM (acm.html)
delete_bucket_cors (**kwargs)
ACMPCA (acm-pca.html) Deletes the CORS configuration information set for the bucket.
AlexaForBusiness See also: AWS API Documentation
(alexaforbusiness.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketCors)
Amplify (amplify.html) Request Syntax
APIGateway
(apigateway.html) response = client.delete_bucket_cors(
ApiGatewayManagement Bucket='string'
Api )
api.html)
Parameters
Boto 3 Docs 1.9.249
documentation (
Returns
../../index.html)
None
TABLE OF CONTENTS
delete_bucket_encryption (**kwargs)
Quickstart
Deletes the server-side encryption configuration from the bucket.
A Sample Tutorial
01/DeleteBucketEncryption)
Code Examples
Request Syntax
User Guides
response = client.delete_bucket_encryption(
Bucket='string'
Available Services (index.html) )
ACM (acm.html)
ACMPCA (acm-pca.html) Parameters

Bucket (string) --
AlexaForBusiness
[REQUIRED]
The name of the bucket containing the server-side encryption configuration
to delete.
APIGateway
Returns
(apigateway.html)
None
Api
(apigatewaymanagement delete_bucket_inventory_configuration (**kwargs)
api.html)
Deletes an inventory configuration (identified by the inventory ID) from the
Boto 3 Docs 1.9.249
bucket.
documentation (
../../index.html)
01/DeleteBucketInventoryConfiguration)
TABLE OF CONTENTS
Request Syntax
Quickstart
(../../guide/quickstart.html) response = client.delete_bucket_inventory_configuration(
A Sample Tutorial Bucket='string',
(../../guide/sqs.html) Id='string'
)
Code Examples
Parameters
User Guides
Bucket (string) --
[REQUIRED]
Available Services (index.html) The name of the bucket containing the inventory configuration to delete.
ACM (acm.html) Id (string) --
ACMPCA (acm-pca.html) [REQUIRED]
AlexaForBusiness The ID used to identify the inventory configuration.

(alexaforbusiness.html) Returns
Amplify (amplify.html) None
APIGateway
(apigateway.html)
delete_bucket_lifecycle (**kwargs)
ApiGatewayManagement Deletes the lifecycle configuration from the bucket.
Api
api.html)
Boto 3 Docs 1.9.249
documentation ( 01/DeleteBucketLifecycle)
../../index.html)
Request Syntax
TABLE OF CONTENTS
response = client.delete_bucket_lifecycle(
Quickstart Bucket='string'
A Sample Tutorial
(../../guide/sqs.html) Parameters
Code Examples
(../../guide/examples.html) Returns
None
User Guides
Available Services (index.html) delete_bucket_metrics_configuration (**kwargs)
ACM (acm.html) Deletes a metrics configuration (specified by the metrics configuration ID) from
the bucket.
AlexaForBusiness (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-
(alexaforbusiness.html) 01/DeleteBucketMetricsConfiguration)
APIGateway
(apigateway.html) response = client.delete_bucket_metrics_configuration(
ApiGatewayManagement Bucket='string',
Api Id='string'
(apigatewaymanagement )
api.html)
Parameters
Boto 3 Docs 1.9.249
Bucket (string) --
documentation ( [REQUIRED]
../../index.html)
The name of the bucket containing the metrics configuration to delete.
TABLE OF CONTENTS Id (string) --

[REQUIRED]
Quickstart The ID used to identify the metrics configuration.
Returns
A Sample Tutorial None
Code Examples
(../../guide/examples.html) delete_bucket_policy (**kwargs)
Deletes the policy from the bucket.
User Guides
(../../guide/index.html) See also: AWS API Documentation
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketPolicy)
Request Syntax
ACM (acm.html)
ACMPCA (acm-pca.html) response = client.delete_bucket_policy(

AlexaForBusiness Bucket='string'
(alexaforbusiness.html) )
APIGateway Parameters
(apigateway.html) Bucket (string) -- [REQUIRED]
ApiGatewayManagement Returns
Api None
api.html)
Boto 3 Docs 1.9.249 delete_bucket_replication (**kwargs)
documentation ( Deletes the replication configuration from the bucket. For information about
replication configuration, see Cross-Region Replication (CRR)
../../index.html)
(https://docs.aws.amazon.com/AmazonS3/latest/dev/crr.html) in the Amazon S3
Developer Guide .
TABLE OF CONTENTS
Quickstart
01/DeleteBucketReplication)
Request Syntax
A Sample Tutorial
response = client.delete_bucket_replication(
Code Examples
Bucket='string'
)
User Guides
Parameters
Available Services (index.html) Bucket (string) --
ACM (acm.html) [REQUIRED]
ACMPCA (acm-pca.html) The bucket name.
AlexaForBusiness
(alexaforbusiness.html) Note
Amplify (amplify.html) It can take a while to propagate the deletion of a replication
configuration to all Amazon S3 systems.
APIGateway
(apigateway.html)
Api None
api.html)
Boto 3 Docs 1.9.249 delete_bucket_tagging (**kwargs)
Deletes the tags from the bucket.
documentation (
../../index.html) See also: AWS API Documentation
01/DeleteBucketTagging)
TABLE OF CONTENTS
Request Syntax
Quickstart
response = client.delete_bucket_tagging(
A Sample Tutorial Bucket='string'
(../../guide/sqs.html) )
Code Examples
(../../guide/examples.html) Parameters
User Guides Bucket (string) -- [REQUIRED]
(../../guide/index.html) Returns
Available Services (index.html) None
ACM (acm.html)
ACMPCA (acm-pca.html) delete_bucket_website (**kwargs)

This operation removes the website configuration from the bucket.
AlexaForBusiness
(alexaforbusiness.html) See also: AWS API Documentation
01/DeleteBucketWebsite)
APIGateway
Request Syntax
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.delete_bucket_website(
documentation ( Bucket='string'
../../index.html) )
TABLE OF CONTENTS Parameters

Quickstart
Returns
None
A Sample Tutorial
Code Examples delete_object (**kwargs)

(../../guide/examples.html) Removes the null version (if there is one) of an object and inserts a delete
marker, which becomes the latest version of the object. If there isn't a null
User Guides
version, Amazon S3 does not remove any objects.
Available Services (index.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObject)
ACM (acm.html) Request Syntax
AlexaForBusiness response = client.delete_object(

(alexaforbusiness.html) Bucket='string',
Key='string',
MFA='string',
APIGateway VersionId='string',
(apigateway.html) RequestPayer='requester',
ApiGatewayManagement BypassGovernanceRetention=True|False
Api )
api.html)
Parameters
Boto 3 Docs 1.9.249
documentation ( Key (string) -- [REQUIRED]
../../index.html) MFA (string) -- The concatenation of the authentication device's serial
number, a space, and the value that is displayed on your authentication
TABLE OF CONTENTS device.
VersionId (string) -- VersionId used to reference a specific version of the
Quickstart object.
(../../guide/quickstart.html) RequestPayer (string) -- Confirms that the requester knows that she or
A Sample Tutorial
Code Examples http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
(../../guide/examples.html) (http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
BypassGovernanceRetention (boolean) -- Indicates whether Amazon S3
User Guides object lock should bypass governance-mode restrictions to process this
(../../guide/index.html) operation.
Available Services (index.html) Return type
ACM (acm.html) dict
ACMPCA (acm-pca.html) Returns
AlexaForBusiness Response Syntax

Amplify (amplify.html) {
'DeleteMarker': True|False,
APIGateway
(apigateway.html)
ApiGatewayManagement }
Api
api.html) Response Structure
(dict) --
Boto 3 Docs 1.9.249
documentation ( DeleteMarker (boolean) --
../../index.html) Specifies whether the versioned object that was permanently deleted
was (true) or was not (false) a delete marker.
TABLE OF CONTENTS VersionId (string) --
Returns the version ID of the delete marker created as a result of the

Quickstart
DELETE operation.
A Sample Tutorial
(../../guide/sqs.html) If present, indicates that the requester was successfully charged for the
request.
Code Examples
User Guides delete_object_tagging (**kwargs)

(../../guide/index.html) Removes the tag-set from an existing object.
Available Services (index.html) See also: AWS API Documentation

ACM (acm.html)
01/DeleteObjectTagging)
Request Syntax
AlexaForBusiness
response = client.delete_object_tagging(
Amplify (amplify.html) Bucket='string',
APIGateway Key='string',
(apigateway.html) VersionId='string'
)
Api
(apigatewaymanagement Parameters
Boto 3 Docs 1.9.249
VersionId (string) -- The versionId of the object that the tag-set will be
documentation ( removed from.
../../index.html)
Return type
dict
TABLE OF CONTENTS
Returns
Quickstart Response Syntax
A Sample Tutorial {
(../../guide/sqs.html) 'VersionId': 'string'
Code Examples }
User Guides Response Structure

(../../guide/index.html) (dict) --
Available Services (index.html) VersionId (string) --
ACM (acm.html) The versionId of the object the tag-set was removed from.
AlexaForBusiness delete_objects (**kwargs)

This operation enables you to delete multiple objects from a bucket using a
Amplify (amplify.html) single HTTP request. You may specify up to 1000 keys.
(apigateway.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjects)
ApiGatewayManagement Request Syntax
Api
api.html)
Boto 3 Docs 1.9.249 response = client.delete_objects(
../../index.html) Delete={
'Objects': [
{
TABLE OF CONTENTS
'Key': 'string',
'VersionId': 'string'
Quickstart
},
],
A Sample Tutorial 'Quiet': True|False
(../../guide/sqs.html) },
Code Examples MFA='string',
(../../guide/examples.html) RequestPayer='requester',
BypassGovernanceRetention=True|False
User Guides
)

Parameters
ACM (acm.html) Bucket (string) -- [REQUIRED]
Delete (dict) --
[REQUIRED]
AlexaForBusiness
Objects (list) -- [REQUIRED]
(dict) --
Amplify (amplify.html) Key (string) -- [REQUIRED]
APIGateway Key name of the object to delete.
(apigateway.html) VersionId (string) --
ApiGatewayManagement VersionId for the specific version of the object to delete.
Api Quiet (boolean) --
(apigatewaymanagement Element to enable quiet mode for the request. When you add this
api.html) element, you must set its value to true.
MFA (string) -- The concatenation of the authentication device's serial
Boto 3 Docs 1.9.249
documentation ( device.
../../index.html) RequestPayer (string) -- Confirms that the requester knows that she or
TABLE OF CONTENTS parameter in their requests. Documentation on downloading objects
Quickstart http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
(../../guide/quickstart.html) (http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
BypassGovernanceRetention (boolean) -- Specifies whether you want to
A Sample Tutorial delete this object even if it has a Governance-type object lock in place.
(../../guide/sqs.html) You must have sufficient permissions to perform this operation.
Code Examples Return type
dict
User Guides Returns
Response Syntax
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'Deleted': [
../../index.html) {
'Key': 'string',
TABLE OF CONTENTS
'DeleteMarkerVersionId': 'string'
Quickstart
},
],
A Sample Tutorial 'RequestCharged': 'requester',
(../../guide/sqs.html) 'Errors': [
Code Examples {
(../../guide/examples.html) 'Key': 'string',
User Guides
'Code': 'string',
'Message': 'string'
]
ACM (acm.html)
}
AlexaForBusiness Response Structure

(dict) --
Deleted (list) --
APIGateway
(dict) --
(apigateway.html)
Key (string) --
ApiGatewayManagement VersionId (string) --
Api DeleteMarker (boolean) --
(apigatewaymanagement DeleteMarkerVersionId (string) --
api.html) RequestCharged (string) --
Boto 3 Docs 1.9.249
request.
documentation (
Errors (list) --
../../index.html)
(dict) --
TABLE OF CONTENTS Key (string) --
Code (string) --
Quickstart
Message (string) --
A Sample Tutorial
(../../guide/sqs.html) delete_public_access_block (**kwargs)
Code Examples Removes the PublicAccessBlock configuration from an Amazon S3 bucket.
User Guides (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-
(../../guide/index.html) 01/DeletePublicAccessBlock)
Request Syntax
ACM (acm.html)
response = client.delete_public_access_block(
ACMPCA (acm-pca.html) Bucket='string'
AlexaForBusiness )
Amplify (amplify.html) Parameters

APIGateway Bucket (string) --
(apigateway.html) [REQUIRED]
ApiGatewayManagement The Amazon S3 bucket whose PublicAccessBlock configuration you want

Api to delete.
api.html) None
Boto 3 Docs 1.9.249
documentation ( download_file (Bucket, Key, Filename, ExtraArgs=None, Callback=None,
../../index.html) Config=None)
Download an S3 object to a file.
TABLE OF CONTENTS
Usage:
Quickstart
(../../guide/quickstart.html) import boto3
A Sample Tutorial
(../../guide/sqs.html) s3.meta.client.download_file('mybucket', 'hello.txt', '/tmp/hello.txt'
Code Examples
Similar behavior as S3Transfer's download_file() method, except that
User Guides parameters are capitalized. Detailed examples can be found at S3Transfer's
(../../guide/index.html) Usage.
Available Services (index.html) Parameters

Bucket (str) -- The name of the bucket to download from.
ACM (acm.html)
Key (str) -- The name of the key to download from.
ACMPCA (acm-pca.html) Filename (str) -- The path to the file to download to.
AlexaForBusiness
operation.
Callback (function) -- A method which takes a number of bytes
Amplify (amplify.html) transferred to be periodically called during the download.
APIGateway Config (boto3.s3.transfer.TransferConfig
(apigateway.html) (../customizations/s3.html#boto3.s3.transfer.TransferConfig)) -- The
transfer configuration to be used when performing the transfer.
Api
api.html)
Boto 3 Docs 1.9.249 download_fileobj (Bucket, Key, Fileobj, ExtraArgs=None, Callback=None,
documentation ( Config=None)
Download an object from S3 to a file-like object.
../../index.html)
The file-like object must be in binary mode.
TABLE OF CONTENTS This is a managed transfer which will perform a multipart download in multiple
Quickstart
Usage:
A Sample Tutorial
(../../guide/sqs.html) import boto3
s3 = boto3.client('s3')
Code Examples
with open('filename', 'wb') as data:
User Guides s3.download_fileobj('mybucket', 'mykey', data)

Fileobj (a file-like object) -- A file-like object to download into. At a
ACM (acm.html)
minimum, it must implement the write method and must accept bytes.
ACMPCA (acm-pca.html) Bucket (str) -- The name of the bucket to download from.
AlexaForBusiness
operation.
Amplify (amplify.html) Callback (function) -- A method which takes a number of bytes
transferred to be periodically called during the download.
APIGateway
Config (boto3.s3.transfer.TransferConfig
(apigateway.html)
(../customizations/s3.html#boto3.s3.transfer.TransferConfig)) -- The
ApiGatewayManagement transfer configuration to be used when performing the download.
Api
api.html)
Boto 3 Docs 1.9.249 generate_presigned_post (Bucket, Key, Fields=None, Conditions=None,
documentation ( ExpiresIn=3600)
../../index.html) Builds the url and the form fields used for a presigned s3 post
Parameters
TABLE OF CONTENTS Bucket (string) -- The name of the bucket to presign the post to. Note that
bucket related conditions should not be included in the conditions
Quickstart parameter.
(../../guide/quickstart.html) Key (string) -- Key name, optionally add ${filename} to the end to attach
the submitted filename. Note that key related conditions and fields are
A Sample Tutorial
filled out for you and should not be included in the Fields or Conditions
parameter.
Code Examples Fields (dict) --
(../../guide/examples.html) A dictionary of prefilled form fields to build on top of. Elements that may
be included are acl, Cache-Control, Content-Type, Content-Disposition,
User Guides
Content-Encoding, Expires, success_action_redirect, redirect,
success_action_status, and x-amz-meta-.
Available Services (index.html) Note that if a particular element is included in the fields dictionary it will
ACM (acm.html) not be automatically added to the conditions list. You must specify a
condition for the element as well.
Conditions (list) --
AlexaForBusiness A list of conditions to include in the policy. Each element can be either a
(alexaforbusiness.html) list or a structure. For example:
Amplify (amplify.html) [
APIGateway {"acl": "public-read"}, ["content-length-range", 2, 5], ["starts-with",
(apigateway.html) "$success_action_redirect", ""]
]
Api
api.html)
Conditions that are included may pertain to acl, content-length-range,
Boto 3 Docs 1.9.249
Cache-Control, Content-Type, Content-Disposition, Content-Encoding,
documentation ( Expires, success_action_redirect, redirect, success_action_status, and/or
../../index.html) x-amz-meta-.
Note that if you include a condition, you must specify the a valid value in
TABLE OF CONTENTS the fields dictionary as well. A value will not be added automatically to the
fields dictionary based on the conditions.
Quickstart
ExpiresIn (int) -- The number of seconds the presigned post is valid for.
Return type
A Sample Tutorial

(../../guide/examples.html) A dictionary with two elements: url and fields . Url is the url to post to.
Fields is a dictionary filled with the form fields and respective values to use
User Guides
when submitting the post. For example:
{'url': 'https://mybucket.s3.amazonaws.com
(https://mybucket.s3.amazonaws.com)
ACM (acm.html) 'fields': {'acl': 'public-read',
ACMPCA (acm-pca.html) 'key': 'mykey', 'signature': 'mysignature', 'policy': 'mybase64
encoded policy'}
AlexaForBusiness
(alexaforbusiness.html) }
APIGateway
generate_presigned_url (ClientMethod, Params=None, ExpiresIn=3600,
(apigateway.html)
HttpMethod=None)
ApiGatewayManagement Generate a presigned url given a client, its method, and arguments
Api
api.html) ClientMethod (string) -- The client method to presign for
Params (dict) -- The parameters normally passed to ClientMethod .
Boto 3 Docs 1.9.249
ExpiresIn (int) -- The number of seconds the presigned url is valid for. By
documentation ( default it expires in an hour (3600 seconds)
../../index.html) HttpMethod (string) -- The http method to use on the generated url. By
default, the http method is whatever is used in the method's model.
TABLE OF CONTENTS
Returns
The presigned url
Quickstart
A Sample Tutorial get_bucket_accelerate_configuration (**kwargs)

(../../guide/sqs.html) Returns the accelerate configuration of a bucket.
Code Examples See also: AWS API Documentation
(../../guide/examples.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-
01/GetBucketAccelerateConfiguration)
User Guides
(../../guide/index.html) Request Syntax

response = client.get_bucket_accelerate_configuration(
ACM (acm.html)
Bucket='string'
ACMPCA (acm-pca.html) )
AlexaForBusiness
(alexaforbusiness.html) Parameters
Amplify (amplify.html) Bucket (string) --
[REQUIRED]
APIGateway
(apigateway.html) Name of the bucket for which the accelerate configuration is retrieved.
ApiGatewayManagement Return type

Api dict
Returns
api.html)
Response Syntax
Boto 3 Docs 1.9.249
documentation (
{
../../index.html)
'Status': 'Enabled'|'Suspended'
}
TABLE OF CONTENTS

(dict) --
A Sample Tutorial Status (string) --
(../../guide/sqs.html) The accelerate configuration of the bucket.
Code Examples
get_bucket_acl (**kwargs)
User Guides Gets the access control policy for the bucket.
Available Services (index.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAcl)
response = client.get_bucket_acl(
AlexaForBusiness
Bucket='string'
)
(apigateway.html)
Return type
Api
dict
api.html) Returns
Response Syntax
Boto 3 Docs 1.9.249
documentation (
{
../../index.html)
'Owner': {
'DisplayName': 'string',
TABLE OF CONTENTS
'ID': 'string'
},
Quickstart
'Grants': [
{
A Sample Tutorial 'Grantee': {
(../../guide/sqs.html) 'DisplayName': 'string',
Code Examples 'EmailAddress': 'string',

(../../guide/examples.html) 'ID': 'string',
'Type': 'CanonicalUser'|'AmazonCustomerByEmail'|'G
User Guides 'URI': 'string'
(../../guide/index.html) },
'Permission': 'FULL_CONTROL'|'WRITE'|'WRITE_ACP'|'READ
},
ACM (acm.html) ]
ACMPCA (acm-pca.html) }
AlexaForBusiness
Response Structure
(dict) --
APIGateway
Owner (dict) --
(apigateway.html)
DisplayName (string) --
ApiGatewayManagement ID (string) --
Api Grants (list) --
(apigatewaymanagement A list of grants.
api.html)
(dict) --
Grantee (dict) --
Boto 3 Docs 1.9.249
documentation ( Screen name of the grantee.
../../index.html)
EmailAddress (string) --
Email address of the grantee.
TABLE OF CONTENTS
ID (string) --
The canonical user ID of the grantee.
Quickstart
(../../guide/quickstart.html) Type (string) --
Type of grantee
A Sample Tutorial
(../../guide/sqs.html) URI (string) --
URI of the grantee group.
Code Examples
(../../guide/examples.html) Permission (string) --
Specifies the permission given to the grantee.
User Guides
Available Services (index.html) get_bucket_analytics_configuration (**kwargs)

Gets an analytics configuration for the bucket (specified by the analytics
ACM (acm.html)
configuration ID).
(alexaforbusiness.html) 01/GetBucketAnalyticsConfiguration)
APIGateway
(apigateway.html) response = client.get_bucket_analytics_configuration(
ApiGatewayManagement Bucket='string',
Api Id='string'
api.html)
Parameters
Boto 3 Docs 1.9.249
Bucket (string) --
../../index.html)
The name of the bucket from which an analytics configuration is
retrieved.
TABLE OF CONTENTS
Id (string) --
Quickstart [REQUIRED]
(../../guide/quickstart.html) The ID that identifies the analytics configuration.
Response Syntax
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'AnalyticsConfiguration': {
../../index.html) 'Id': 'string',
'Filter': {
'Prefix': 'string',
TABLE OF CONTENTS
'Tag': {
'Key': 'string',
Quickstart
'Value': 'string'
},
A Sample Tutorial 'And': {
(../../guide/sqs.html) 'Prefix': 'string',
Code Examples 'Tags': [
(../../guide/examples.html) {
'Key': 'string',
User Guides
'Value': 'string'
},
Available Services (index.html) ]
}
ACM (acm.html)
},
ACMPCA (acm-pca.html) 'StorageClassAnalysis': {
'DataExport': {
AlexaForBusiness
(alexaforbusiness.html) 'OutputSchemaVersion': 'V_1',
'Destination': {
Amplify (amplify.html) 'S3BucketDestination': {
APIGateway 'Format': 'CSV',
(apigateway.html) 'BucketAccountId': 'string',
'Bucket': 'string',
'Prefix': 'string'
Api
}
api.html) }
}
Boto 3 Docs 1.9.249
}
documentation ( }
../../index.html) }
TABLE OF CONTENTS
Response Structure
Quickstart (dict) --
(../../guide/quickstart.html) AnalyticsConfiguration (dict) --
A Sample Tutorial The configuration and any analyses for the analytics filter.
Id (string) --
Code Examples
(../../guide/examples.html) The ID that identifies the analytics configuration.
Filter (dict) --
User Guides
(../../guide/index.html) The filter used to describe a set of objects for analyses. A filter must
have exactly one prefix, one tag, or one conjunction
(AnalyticsAndOperator). If no filter is provided, all objects will be
ACM (acm.html) considered in any analysis.
ACMPCA (acm-pca.html) Prefix (string) --
AlexaForBusiness The prefix to use when evaluating an analytics filter.

Tag (dict) --
The tag to use when evaluating an analytics filter.
APIGateway
Key (string) --
(apigateway.html)
Name of the tag.
Api Value (string) --
(apigatewaymanagement Value of the tag.
api.html)
And (dict) --
Boto 3 Docs 1.9.249
documentation ( A conjunction (logical AND) of predicates, which is used in
evaluating an analytics filter. The operator must have at least two
../../index.html)
predicates.
TABLE OF CONTENTS Prefix (string) --
The prefix to use when evaluating an AND predicate: The prefix

Quickstart that an object must have to be included in the metrics results.
Tags (list) --
A Sample Tutorial
The list of tags to use when evaluating an AND predicate.
(dict) --
Code Examples
User Guides Name of the tag.

(../../guide/index.html) Value (string) --
Available Services (index.html) Value of the tag.
ACM (acm.html) StorageClassAnalysis (dict) --
ACMPCA (acm-pca.html) Contains data related to access patterns to be collected and made
available to analyze the tradeoffs between different storage classes.
AlexaForBusiness
(alexaforbusiness.html) DataExport (dict) --
Amplify (amplify.html) Specifies how data related to the storage class analysis for an
Amazon S3 bucket should be exported.
APIGateway
(apigateway.html) OutputSchemaVersion (string) --
ApiGatewayManagement The version of the output schema to use when exporting data.
Api Must be V_1 .
Destination (dict) --
api.html)
The place to store the data for an analysis.
Boto 3 Docs 1.9.249
documentation ( S3BucketDestination (dict) --
../../index.html) A destination signifying output to an S3 bucket.

Format (string) --
TABLE OF CONTENTS
Specifies the file format used when exporting data to
Amazon S3.
Quickstart
(../../guide/quickstart.html) BucketAccountId (string) --
A Sample Tutorial The account ID that owns the destination bucket. If no

(../../guide/sqs.html) account ID is provided, the owner will not be validated prior
to exporting data.
Code Examples
(../../guide/examples.html) Bucket (string) --
User Guides The Amazon Resource Name (ARN) of the bucket to which
(../../guide/index.html) data is exported.
Prefix (string) --
The prefix to use when exporting data. The prefix is
ACM (acm.html)
prepended to all results.
AlexaForBusiness
(alexaforbusiness.html) get_bucket_cors (**kwargs)
Returns the CORS configuration for the bucket.
APIGateway
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketCors)
(apigateway.html)
Request Syntax
Api
api.html)
Boto 3 Docs 1.9.249 response = client.get_bucket_cors(
../../index.html) )

Quickstart
Return type
dict
A Sample Tutorial
(../../guide/sqs.html) Returns
Response Syntax
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'CORSRules': [
../../index.html) {
'AllowedHeaders': [
'string',
TABLE OF CONTENTS
],
'AllowedMethods': [
Quickstart
'string',
],
A Sample Tutorial 'AllowedOrigins': [
(../../guide/sqs.html) 'string',
Code Examples ],
(../../guide/examples.html) 'ExposeHeaders': [
'string',
User Guides
],
'MaxAgeSeconds': 123
]
ACM (acm.html)
}

(dict) --
Amplify (amplify.html) CORSRules (list) --
APIGateway (dict) --
(apigateway.html) Specifies a cross-origin access rule for an Amazon S3 bucket.
ApiGatewayManagement AllowedHeaders (list) --

Api Headers that are specified in the Access-Control-Request-Headers
(apigatewaymanagement header. These headers are allowed in a preflight OPTIONS request.
api.html) In response to any preflight OPTIONS request, Amazon S3 returns
any requested headers that are allowed.
Boto 3 Docs 1.9.249
documentation ( (string) --
AllowedMethods (list) --
../../index.html)
An HTTP method that you allow the origin to execute. Valid values
are GET , PUT , HEAD , POST , and DELETE .
TABLE OF CONTENTS
(string) --
Quickstart
AllowedOrigins (list) --
One or more origins you want customers to be able to access the
bucket from.
A Sample Tutorial
(string) --
ExposeHeaders (list) --
Code Examples One or more headers in the response that you want customers to
(../../guide/examples.html) be able to access from their applications (for example, from a
JavaScript XMLHttpRequest object).
User Guides
(../../guide/index.html) (string) --
MaxAgeSeconds (integer) --
The time in seconds that your browser is to cache the preflight
ACM (acm.html) response for the specified resource.
AlexaForBusiness get_bucket_encryption (**kwargs)

(alexaforbusiness.html) Returns the server-side encryption configuration of a bucket.
Amplify (amplify.html) See also: AWS API Documentation
APIGateway (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-
(apigateway.html) 01/GetBucketEncryption)

Api
api.html)
Boto 3 Docs 1.9.249 response = client.get_bucket_encryption(
../../index.html) )

Bucket (string) --
The name of the bucket from which the server-side encryption
A Sample Tutorial configuration is retrieved.
Return type
Code Examples dict
Returns
User Guides Response Syntax
Available Services (index.html) {
ACM (acm.html) 'ServerSideEncryptionConfiguration': {

'Rules': [
ACMPCA (acm-pca.html) {
AlexaForBusiness 'ApplyServerSideEncryptionByDefault': {
(alexaforbusiness.html) 'SSEAlgorithm': 'AES256'|'aws:kms',
'KMSMasterKeyID': 'string'
}
APIGateway },
(apigateway.html) ]
Api }
api.html)
Response Structure
Boto 3 Docs 1.9.249
documentation ( (dict) --
ServerSideEncryptionConfiguration (dict) --
../../index.html)
Rules (list) --
Container for information about a particular server-side encryption
TABLE OF CONTENTS configuration rule.
(dict) --
Quickstart
Specifies the default server-side encryption configuration.
ApplyServerSideEncryptionByDefault (dict) --
A Sample Tutorial
Specifies the default server-side encryption to apply to new
objects in the bucket. If a PUT Object request doesn't specify any
Code Examples server-side encryption, this default encryption will be applied.
SSEAlgorithm (string) --
User Guides Server-side encryption algorithm to use for the default
(../../guide/index.html) encryption.
Available Services (index.html) KMSMasterKeyID (string) --

KMS master key ID to use for the default encryption. This
ACM (acm.html) parameter is allowed if and only if SSEAlgorithm is set to
ACMPCA (acm-pca.html) aws:kms .
AlexaForBusiness
get_bucket_inventory_configuration (**kwargs)
Amplify (amplify.html) Returns an inventory configuration (identified by the inventory ID) from the
APIGateway bucket.
(apigateway.html) See also: AWS API Documentation
ApiGatewayManagement (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-
Api 01/GetBucketInventoryConfiguration)
(apigatewaymanagement Request Syntax
api.html)
Boto 3 Docs 1.9.249 response = client.get_bucket_inventory_configuration(
../../index.html) Id='string'
)
TABLE OF CONTENTS
Parameters
A Sample Tutorial The name of the bucket containing the inventory configuration to
(../../guide/sqs.html) retrieve.
Code Examples Id (string) --
(../../guide/examples.html) [REQUIRED]
User Guides The ID used to identify the inventory configuration.

Return type
Available Services (index.html) dict
ACMPCA (acm-pca.html) Response Syntax
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'InventoryConfiguration': {
../../index.html) 'Destination': {
'S3BucketDestination': {
'AccountId': 'string',
TABLE OF CONTENTS
'Bucket': 'string',
'Format': 'CSV'|'ORC'|'Parquet',
Quickstart
'Prefix': 'string',
'Encryption': {
A Sample Tutorial 'SSES3': {},
(../../guide/sqs.html) 'SSEKMS': {
Code Examples 'KeyId': 'string'
}
User Guides
}
},
Available Services (index.html) 'IsEnabled': True|False,
'Filter': {
ACM (acm.html)
'Prefix': 'string'
ACMPCA (acm-pca.html) },
'Id': 'string',
AlexaForBusiness
(alexaforbusiness.html) 'IncludedObjectVersions': 'All'|'Current',
'OptionalFields': [
Amplify (amplify.html) 'Size'|'LastModifiedDate'|'StorageClass'|'ETag'|'IsMul
APIGateway ],
(apigateway.html) 'Schedule': {
'Frequency': 'Daily'|'Weekly'
}
Api
}
api.html) }
Boto 3 Docs 1.9.249
documentation ( Response Structure
../../index.html) (dict) --
InventoryConfiguration (dict) --
TABLE OF CONTENTS
Specifies the inventory configuration.
Quickstart Destination (dict) --
Contains information about where to publish the inventory results.
A Sample Tutorial
(../../guide/sqs.html) S3BucketDestination (dict) --
Code Examples Contains the bucket name, file format, bucket owner (optional),
(../../guide/examples.html) and prefix (optional) where inventory results are published.
AccountId (string) --
User Guides
(../../guide/index.html) The ID of the account that owns the destination bucket.
Available Services (index.html) Bucket (string) --
ACM (acm.html) The Amazon resource name (ARN) of the bucket where inventory
results will be published.
Format (string) --
AlexaForBusiness
(alexaforbusiness.html) Specifies the output format of the inventory results.
Amplify (amplify.html) Prefix (string) --
APIGateway The prefix that is prepended to all inventory results.

(apigateway.html) Encryption (dict) --
ApiGatewayManagement Contains the type of server-side encryption used to encrypt the
Api inventory results.
api.html) SSES3 (dict) --
Specifies the use of SSE-S3 to encrypt delivered Inventory
Boto 3 Docs 1.9.249
reports.
documentation (
SSEKMS (dict) --
../../index.html)
Specifies the use of SSE-KMS to encrypt delivered Inventory
TABLE OF CONTENTS reports.
KeyId (string) --
Quickstart
Specifies the ID of the AWS Key Management Service (KMS)
master encryption key to use for encrypting Inventory
A Sample Tutorial reports.
IsEnabled (boolean) --
Code Examples
Specifies whether the inventory is enabled or disabled. If set to True ,
an inventory list is generated. If set to False , no inventory list is
User Guides generated.
Filter (dict) --
Available Services (index.html) Specifies an inventory filter. The inventory only includes objects that
ACM (acm.html) meet the filter's criteria.
ACMPCA (acm-pca.html) Prefix (string) --
AlexaForBusiness The prefix that an object must have to be included in the inventory
(alexaforbusiness.html) results.
Amplify (amplify.html) Id (string) --
APIGateway The ID used to identify the inventory configuration.

(apigateway.html) IncludedObjectVersions (string) --
ApiGatewayManagement Object versions to include in the inventory list. If set to All , the list
Api includes all the object versions, which adds the version-related fields
(apigatewaymanagement VersionId , IsLatest , and DeleteMarker to the list. If set to Current
api.html) , the list does not contain these version-related fields.
OptionalFields (list) --
Boto 3 Docs 1.9.249
documentation ( Contains the optional fields that are included in the inventory results.
../../index.html) (string) --
Schedule (dict) --
TABLE OF CONTENTS Specifies the schedule for generating inventory results.
Frequency (string) --
Quickstart
(../../guide/quickstart.html) Specifies how frequently inventory results are produced.
A Sample Tutorial
get_bucket_lifecycle (**kwargs)
Code Examples No longer used, see the GetBucketLifecycleConfiguration operation.
User Guides
Danger
This operation is deprecated and may not function as expected. This
Available Services (index.html) operation should not be used going forward and is only kept for the
purpose of backwards compatiblity.
ACM (acm.html)
AlexaForBusiness
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLifecycle)
Request Syntax
APIGateway
response = client.get_bucket_lifecycle(
(apigateway.html)
Bucket='string'
ApiGatewayManagement )
Api
api.html) Parameters
Boto 3 Docs 1.9.249
documentation ( Return type
dict
../../index.html)
Returns
TABLE OF CONTENTS Response Syntax
Quickstart
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'Rules': [
../../index.html) {
'Expiration': {
'Date': datetime(2015, 1, 1),
TABLE OF CONTENTS
'Days': 123,
'ExpiredObjectDeleteMarker': True|False
Quickstart
},
'ID': 'string',
A Sample Tutorial 'Prefix': 'string',
(../../guide/sqs.html) 'Status': 'Enabled'|'Disabled',
Code Examples 'Transition': {
(../../guide/examples.html) 'Date': datetime(2015, 1, 1),
'Days': 123,
User Guides
'StorageClass': 'GLACIER'|'STANDARD_IA'|'ONEZONE_I
},
Available Services (index.html) 'NoncurrentVersionTransition': {
'NoncurrentDays': 123,
ACM (acm.html)
'NoncurrentVersionExpiration': {
AlexaForBusiness
(alexaforbusiness.html) 'NoncurrentDays': 123
},
Amplify (amplify.html) 'AbortIncompleteMultipartUpload': {
APIGateway 'DaysAfterInitiation': 123
(apigateway.html) }
},
]
Api
}
api.html)
Response Structure
Boto 3 Docs 1.9.249
Rules (list) --
../../index.html)
(dict) --
Specifies lifecycle rules for an Amazon S3 bucket. For more
TABLE OF CONTENTS information, see PUT Bucket lifecycle
(https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycl
Quickstart in the Amazon Simple Storage Service API Reference .
Expiration (dict) --
A Sample Tutorial Date (datetime) --
(../../guide/sqs.html) Indicates at what date the object is to be moved or deleted.
Code Examples Should be in GMT ISO 8601 Format.
(../../guide/examples.html) Days (integer) --
Indicates the lifetime, in days, of the objects that are subject to
User Guides
the rule. The value must be a non-zero positive integer.
ExpiredObjectDeleteMarker (boolean) --
Available Services (index.html) Indicates whether Amazon S3 will remove a delete marker with
ACM (acm.html) no noncurrent versions. If set to true, the delete marker will be
expired; if set to false the policy takes no action. This cannot be
specified with Days or Date in a Lifecycle Expiration Policy.
AlexaForBusiness
ID (string) --
Unique identifier for the rule. The value can't be longer than 255
Amplify (amplify.html) characters.
APIGateway Prefix (string) --

(apigateway.html) Object key prefix that identifies one or more objects to which this
rule applies.
Api Status (string) --
(apigatewaymanagement If Enabled , the rule is currently being applied. If Disabled , the rule
api.html) is not currently being applied.
Transition (dict) --
Boto 3 Docs 1.9.249
Date (datetime) --
documentation ( Indicates when objects are transitioned to the specified storage
../../index.html) class. The date value must be in ISO 8601 format. The time is
always midnight UTC.
TABLE OF CONTENTS Days (integer) --
Indicates the number of days after creation when objects are
Quickstart transitioned to the specified storage class. The value must be a
(../../guide/quickstart.html) positive integer.
A Sample Tutorial StorageClass (string) --
(../../guide/sqs.html) The storage class to which you want the object to transition.
Code Examples NoncurrentVersionTransition (dict) --
(../../guide/examples.html) NoncurrentDays (integer) --
Specifies the number of days an object is noncurrent before
User Guides
Amazon S3 can perform the associated action. For information
about the noncurrent days calculations, see How Amazon S3
Available Services (index.html) Calculates When an Object Became Noncurrent
(https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-
ACM (acm.html)
control.html) in the Amazon Simple Storage Service Developer
ACMPCA (acm-pca.html) Guide .
AlexaForBusiness StorageClass (string) --

(alexaforbusiness.html) The class of storage used to store the object.
Amplify (amplify.html) NoncurrentVersionExpiration (dict) --

NoncurrentDays (integer) --
APIGateway
(apigateway.html)
ApiGatewayManagement about the noncurrent days calculations, see How Amazon S3
Api Calculates When an Object Became Noncurrent
api.html)
(https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-
Boto 3 Docs 1.9.249
lifecycle-rules.html#non-current-days-calculations) in the
documentation ( Amazon Simple Storage Service Developer Guide.
../../index.html)
AbortIncompleteMultipartUpload (dict) --
DaysAfterInitiation (integer) --
TABLE OF CONTENTS Specifies the number of days after which Amazon S3 aborts an
incomplete multipart upload.
Quickstart
A Sample Tutorial get_bucket_lifecycle_configuration (**kwargs)

(../../guide/sqs.html) Returns the lifecycle configuration information set on the bucket.

(../../guide/examples.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-
01/GetBucketLifecycleConfiguration)
User Guides

response = client.get_bucket_lifecycle_configuration(
ACM (acm.html) Bucket='string'
AlexaForBusiness
Return type
APIGateway
(apigateway.html) dict
Api Response Syntax
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'Rules': [
../../index.html) {
'Expiration': {
TABLE OF CONTENTS
'Days': 123,
Quickstart
},
'ID': 'string',
(../../guide/sqs.html) 'Filter': {
Code Examples 'Prefix': 'string',
(../../guide/examples.html) 'Tag': {
'Key': 'string',
User Guides
'Value': 'string'
},
Available Services (index.html) 'And': {
'Prefix': 'string',
ACM (acm.html)
'Tags': [
ACMPCA (acm-pca.html) {
'Key': 'string',
AlexaForBusiness
(alexaforbusiness.html) 'Value': 'string'
},
Amplify (amplify.html) ]
APIGateway }
(apigateway.html) },
'Status': 'Enabled'|'Disabled',
'Transitions': [
Api
{
api.html) 'Date': datetime(2015, 1, 1),
'Days': 123,
Boto 3 Docs 1.9.249
'StorageClass': 'GLACIER'|'STANDARD_IA'|'ONEZO
documentation ( },
../../index.html) ],
'NoncurrentVersionTransitions': [
TABLE OF CONTENTS {
Quickstart 'StorageClass': 'GLACIER'|'STANDARD_IA'|'ONEZO
(../../guide/quickstart.html) },
],
A Sample Tutorial
'NoncurrentDays': 123
Code Examples },
(../../guide/examples.html) 'AbortIncompleteMultipartUpload': {
User Guides 'DaysAfterInitiation': 123
(../../guide/index.html) }
},
ACM (acm.html) }

(dict) --
Amplify (amplify.html) Rules (list) --
(apigateway.html) Expiration (dict) --
Date (datetime) --
Indicates at what date the object is to be moved or deleted.
Api
Should be in GMT ISO 8601 Format.
api.html) Days (integer) --
Boto 3 Docs 1.9.249
documentation (
../../index.html)
Indicates whether Amazon S3 will remove a delete marker with
no noncurrent versions. If set to true, the delete marker will be
TABLE OF CONTENTS expired; if set to false the policy takes no action. This cannot be
Quickstart
ID (string) --
Unique identifier for the rule. The value cannot be longer than 255
A Sample Tutorial characters.
Prefix (string) --
Code Examples Prefix identifying one or more objects to which the rule applies.
(../../guide/examples.html) This is No longer used; use Filter instead.
User Guides Filter (dict) --

(../../guide/index.html) Prefix (string) --
Prefix identifying one or more objects to which the rule applies.
Tag (dict) --
ACM (acm.html) This tag must exist in the object's tag set in order for the rule to
ACMPCA (acm-pca.html) apply.
AlexaForBusiness Key (string) --

(alexaforbusiness.html) Name of the tag.
Amplify (amplify.html) Value (string) --

Value of the tag.
APIGateway
(apigateway.html) And (dict) --
Prefix (string) --
Tags (list) --
Api
All of these tags must exist in the object's tag set in order for
the rule to apply.
api.html)
(dict) --
Boto 3 Docs 1.9.249
Key (string) --
documentation ( Name of the tag.
../../index.html)
Value (string) --
Value of the tag.
TABLE OF CONTENTS
Status (string) --
If 'Enabled', the rule is currently being applied. If 'Disabled', the rule
Quickstart
is not currently being applied.
Transitions (list) --
A Sample Tutorial
(dict) --
Specifies when an object transitions to a specified storage class.
Code Examples
Date (datetime) --
Indicates when objects are transitioned to the specified
User Guides storage class. The date value must be in ISO 8601 format. The
(../../guide/index.html) time is always midnight UTC.
Available Services (index.html) Days (integer) --

ACM (acm.html) transitioned to the specified storage class. The value must be a
ACMPCA (acm-pca.html) positive integer.

(alexaforbusiness.html) The storage class to which you want the object to transition.
Amplify (amplify.html) NoncurrentVersionTransitions (list) --

(dict) --
APIGateway
Container for the transition rule that describes when noncurrent
(apigateway.html)
objects transition to the STANDARD_IA , ONEZONE_IA ,
ApiGatewayManagement INTELLIGENT_TIERING , GLACIER , or DEEP_ARCHIVE storage class.
Api If your bucket is versioning-enabled (or versioning is suspended),
(apigatewaymanagement you can set this action to request that Amazon S3 transition
api.html)
noncurrent object versions to the STANDARD_IA , ONEZONE_IA ,
Boto 3 Docs 1.9.249
INTELLIGENT_TIERING , GLACIER , or DEEP_ARCHIVE storage class
documentation ( at a specific period in the object's lifetime.
../../index.html)
TABLE OF CONTENTS
Quickstart Calculates When an Object Became Noncurrent
(../../guide/quickstart.html) (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-
A Sample Tutorial access-control.html) in the Amazon Simple Storage Service
(../../guide/sqs.html) Developer Guide .
Code Examples StorageClass (string) --

(../../guide/examples.html) The class of storage used to store the object.
NoncurrentVersionExpiration (dict) --
User Guides
Available Services (index.html) Amazon S3 can perform the associated action. For information
ACM (acm.html)
Calculates When an Object Became Noncurrent
ACMPCA (acm-pca.html) (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-
lifecycle-rules.html#non-current-days-calculations) in the
AlexaForBusiness
Amazon Simple Storage Service Developer Guide.
APIGateway Specifies the number of days after which Amazon S3 aborts an
(apigateway.html) incomplete multipart upload.
Api
(apigatewaymanagement get_bucket_location (**kwargs)
api.html) Returns the region the bucket resides in.
Boto 3 Docs 1.9.249
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLocation)
documentation (
Request Syntax
../../index.html)
TABLE OF CONTENTS response = client.get_bucket_location(

Bucket='string'
Quickstart )
A Sample Tutorial Parameters

(../../guide/sqs.html) Bucket (string) -- [REQUIRED]
(../../guide/examples.html) dict
User Guides Returns
(../../guide/index.html) Response Syntax

{
ACM (acm.html)
'LocationConstraint': 'EU'|'eu-west-1'|'us-west-1'|'us-west-2'
AlexaForBusiness
Amplify (amplify.html) Response Structure
(apigateway.html) LocationConstraint (string) --
Api get_bucket_logging (**kwargs)
api.html)
Returns the logging status of a bucket and the permissions users have to view
Boto 3 Docs 1.9.249
and modify that status. To use GET, you must be the bucket owner.
documentation (
../../index.html)
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLogging)
Quickstart response = client.get_bucket_logging(

(../../guide/quickstart.html) Bucket='string'
A Sample Tutorial )

(../../guide/examples.html) Bucket (string) -- [REQUIRED]
User Guides Return type

(../../guide/index.html) dict
Available Services (index.html) Returns

Response Syntax
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'LoggingEnabled': {
../../index.html) 'TargetBucket': 'string',
'TargetGrants': [
{
TABLE OF CONTENTS
'Grantee': {
Quickstart
'EmailAddress': 'string',
'ID': 'string',
A Sample Tutorial 'Type': 'CanonicalUser'|'AmazonCustomerByEmail
(../../guide/sqs.html) 'URI': 'string'
Code Examples },
(../../guide/examples.html) 'Permission': 'FULL_CONTROL'|'READ'|'WRITE'
},
User Guides
],
'TargetPrefix': 'string'
Available Services (index.html) }
}
ACM (acm.html)

(dict) --
Amplify (amplify.html) LoggingEnabled (dict) --
TargetBucket (string) --
APIGateway
Specifies the bucket where you want Amazon S3 to store server
(apigateway.html)
access logs. You can have your logs delivered to any bucket that you
ApiGatewayManagement own, including the same bucket that is being logged. You can also
Api configure multiple buckets to deliver their logs to the same target
api.html)
bucket. In this case you should choose a different TargetPrefix for
Boto 3 Docs 1.9.249
each source bucket so that the delivered log files can be
documentation ( distinguished by key.
../../index.html)
TargetGrants (list) --
(dict) --
TABLE OF CONTENTS Grantee (dict) --
Quickstart Screen name of the grantee.
A Sample Tutorial Email address of the grantee.
ID (string) --
Code Examples The canonical user ID of the grantee.
Type (string) --
User Guides Type of grantee
URI (string) --
Available Services (index.html) URI of the grantee group.
ACM (acm.html) Permission (string) --

Logging permissions assigned to the Grantee for the bucket.
TargetPrefix (string) --
AlexaForBusiness A prefix for all log object keys. If you store log files from multiple
(alexaforbusiness.html) Amazon S3 buckets in a single bucket, you can use a prefix to
Amplify (amplify.html) distinguish which log files came from which bucket.
APIGateway
(apigateway.html)
get_bucket_metrics_configuration (**kwargs)
ApiGatewayManagement Gets a metrics configuration (specified by the metrics configuration ID) from the
Api bucket.
api.html)
Boto 3 Docs 1.9.249
documentation ( 01/GetBucketMetricsConfiguration)
../../index.html)
Request Syntax
TABLE OF CONTENTS
response = client.get_bucket_metrics_configuration(
(../../guide/quickstart.html) Id='string'
)
A Sample Tutorial
Parameters
Code Examples
Bucket (string) --
[REQUIRED]
User Guides
The name of the bucket containing the metrics configuration to retrieve.
Id (string) --
Available Services (index.html) [REQUIRED]
ACM (acm.html) The ID used to identify the metrics configuration.
ACMPCA (acm-pca.html) Return type
AlexaForBusiness dict
Returns
Response Syntax
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'MetricsConfiguration': {
'Filter': {
'Prefix': 'string',
TABLE OF CONTENTS
'Tag': {
'Key': 'string',
Quickstart
'Value': 'string'
},
A Sample Tutorial 'And': {
Code Examples 'Tags': [
'Key': 'string',
User Guides
'Value': 'string'
},
}
ACM (acm.html)
}
}
AlexaForBusiness
Amplify (amplify.html) Response Structure
(apigateway.html) MetricsConfiguration (dict) --
ApiGatewayManagement Specifies the metrics configuration.
Api
(apigatewaymanagement Id (string) --
api.html) The ID used to identify the metrics configuration.
Filter (dict) --
Boto 3 Docs 1.9.249
documentation ( Specifies a metrics configuration filter. The metrics configuration will
only include objects that meet the filter's criteria. A filter must be a
../../index.html)
prefix, a tag, or a conjunction (MetricsAndOperator).
TABLE OF CONTENTS Prefix (string) --
The prefix used when evaluating a metrics filter.

Quickstart
Tag (dict) --
The tag used when evaluating a metrics filter.
A Sample Tutorial
(../../guide/sqs.html) Key (string) --
Code Examples Name of the tag.

Value (string) --
User Guides Value of the tag.
And (dict) --
A conjunction (logical AND) of predicates, which is used in
ACM (acm.html) evaluating a metrics filter. The operator must have at least two
predicates, and an object must match all of the predicates in order
for the filter to apply.
AlexaForBusiness
Prefix (string) --
The prefix used when evaluating an AND predicate.
Tags (list) --
APIGateway
(apigateway.html) The list of tags used when evaluating an AND predicate.
ApiGatewayManagement (dict) --
Api
Key (string) --
api.html) Name of the tag.
Value (string) --
Boto 3 Docs 1.9.249
documentation ( Value of the tag.
../../index.html)
get_bucket_notification (**kwargs)
TABLE OF CONTENTS
No longer used, see the GetBucketNotificationConfiguration operation.
Quickstart
(../../guide/quickstart.html) Danger
A Sample Tutorial This operation is deprecated and may not function as expected. This
(../../guide/sqs.html) operation should not be used going forward and is only kept for the
Code Examples
User Guides
01/GetBucketNotification)
Request Syntax
ACM (acm.html)
ACMPCA (acm-pca.html) response = client.get_bucket_notification(

Bucket='string'
AlexaForBusiness
Parameters
APIGateway
Bucket (string) --
(apigateway.html)
[REQUIRED]
Name of the bucket to get the notification configuration for.
Api
(apigatewaymanagement Return type
api.html) dict
Returns
Boto 3 Docs 1.9.249
Response Syntax
documentation (
../../index.html)
TABLE OF CONTENTS
Quickstart
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'TopicConfiguration': {
'Events': [
's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|
TABLE OF CONTENTS
],
'Event': 's3:ReducedRedundancyLostObject'|'s3:ObjectCreate
Quickstart
'Topic': 'string'
},
A Sample Tutorial 'QueueConfiguration': {
(../../guide/sqs.html) 'Id': 'string',
Code Examples 'Event': 's3:ReducedRedundancyLostObject'|'s3:ObjectCreate
(../../guide/examples.html) 'Events': [
User Guides
],
'Queue': 'string'
'CloudFunctionConfiguration': {
ACM (acm.html)
'Id': 'string',
ACMPCA (acm-pca.html) 'Event': 's3:ReducedRedundancyLostObject'|'s3:ObjectCreate
'Events': [
AlexaForBusiness
(alexaforbusiness.html) 's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|
],
Amplify (amplify.html) 'CloudFunction': 'string',
APIGateway 'InvocationRole': 'string'
(apigateway.html) }
}
Api
api.html) Response Structure
(dict) --
Boto 3 Docs 1.9.249
TopicConfiguration (dict) --
documentation ( Id (string) --
../../index.html) An optional unique identifier for configurations in a notification
configuration. If you don't provide one, Amazon S3 will assign an ID.
TABLE OF CONTENTS Events (list) --
(string) --
Quickstart The bucket event for which to send notifications.
Event (string) --
A Sample Tutorial Bucket event for which to send notifications.
Topic (string) --
Code Examples Amazon SNS topic to which Amazon S3 will publish a message to
(../../guide/examples.html) report the specified events for the bucket.
User Guides QueueConfiguration (dict) --

(../../guide/index.html) Id (string) --
An optional unique identifier for configurations in a notification
Available Services (index.html) configuration. If you don't provide one, Amazon S3 will assign an ID.
ACM (acm.html) Event (string) --
ACMPCA (acm-pca.html) The bucket event for which to send notifications.
AlexaForBusiness Events (list) --

(alexaforbusiness.html) (string) --
The bucket event for which to send notifications.
Queue (string) --
APIGateway
CloudFunctionConfiguration (dict) --
(apigateway.html)
Id (string) --
ApiGatewayManagement An optional unique identifier for configurations in a notification
Api configuration. If you don't provide one, Amazon S3 will assign an ID.
Event (string) --
api.html)
Boto 3 Docs 1.9.249
documentation ( Events (list) --
(string) --
../../index.html)
TABLE OF CONTENTS CloudFunction (string) --

InvocationRole (string) --
Quickstart
get_bucket_notification_configuration (**kwargs)
A Sample Tutorial
Returns the notification configuration of a bucket.
Code Examples
01/GetBucketNotificationConfiguration)
User Guides Request Syntax
Available Services (index.html) response = client.get_bucket_notification_configuration(

Bucket='string'
ACM (acm.html)
)
AlexaForBusiness
Parameters
Bucket (string) --
Amplify (amplify.html) [REQUIRED]
APIGateway Name of the bucket to get the notification configuration for.
(apigateway.html)
Return type
ApiGatewayManagement dict
Api
api.html) Response Syntax
Boto 3 Docs 1.9.249 {
documentation ( 'TopicConfigurations': [
../../index.html) {
'Id': 'string',
'TopicArn': 'string',
TABLE OF CONTENTS
'Events': [
's3:ReducedRedundancyLostObject'|'s3:ObjectCreated
Quickstart
],
'Filter': {
A Sample Tutorial 'Key': {
(../../guide/sqs.html) 'FilterRules': [
Code Examples {
(../../guide/examples.html) 'Name': 'prefix'|'suffix',
'Value': 'string'
User Guides
},
]
}
ACM (acm.html)
},
ACMPCA (acm-pca.html) ],
'QueueConfigurations': [
AlexaForBusiness
(alexaforbusiness.html) {
'Id': 'string',
Amplify (amplify.html) 'QueueArn': 'string',
APIGateway 'Events': [
(apigateway.html) 's3:ReducedRedundancyLostObject'|'s3:ObjectCreated
],
'Filter': {
Api
'Key': {
api.html) 'FilterRules': [
{
Boto 3 Docs 1.9.249
'Name': 'prefix'|'suffix',
documentation ( 'Value': 'string'
../../index.html) },
]
TABLE OF CONTENTS }
}
Quickstart },
(../../guide/quickstart.html) ],
'LambdaFunctionConfigurations': [
A Sample Tutorial
{
'Id': 'string',
Code Examples 'LambdaFunctionArn': 'string',
(../../guide/examples.html) 'Events': [
User Guides 's3:ReducedRedundancyLostObject'|'s3:ObjectCreated
(../../guide/index.html) ],
'Filter': {
Available Services (index.html) 'Key': {
ACM (acm.html) 'FilterRules': [
{
AlexaForBusiness 'Value': 'string'
Amplify (amplify.html) ]
}
APIGateway }
(apigateway.html)
},
ApiGatewayManagement ]
Api }
api.html)
Response Structure
Boto 3 Docs 1.9.249
A container for specifying the notification configuration of the bucket. If
../../index.html)
this element is empty, notifications are turned off for the bucket.
TABLE OF CONTENTS TopicConfigurations (list) --

The topic to which notifications are sent and the events for which
notifications are generated.
Quickstart
(../../guide/quickstart.html) (dict) --
A container for specifying the configuration for publication of
A Sample Tutorial
messages to an Amazon Simple Notification Service (Amazon SNS)
topic when Amazon S3 detects specified events.
Code Examples
Id (string) --
User Guides configuration. If you don't provide one, Amazon S3 will assign an
(../../guide/index.html) ID.
Available Services (index.html) TopicArn (string) --

The Amazon Resource Name (ARN) of the Amazon SNS topic to
ACM (acm.html) which Amazon S3 publishes a message when it detects events of
ACMPCA (acm-pca.html) the specified type.
AlexaForBusiness Events (list) --

(alexaforbusiness.html) The Amazon S3 bucket event about which to send notifications. For
more information, see Supported Event Types
(https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.h
APIGateway in the Amazon Simple Storage Service Developer Guide .
(apigateway.html)
(string) --
ApiGatewayManagement The bucket event for which to send notifications.
Api
Filter (dict) --
Key (dict) --
api.html)
FilterRules (list) --
Boto 3 Docs 1.9.249
(dict) --
documentation ( Specifies the Amazon S3 object key name to filter on and
../../index.html) whether to filter on the suffix or prefix of the key name.
Name (string) --
TABLE OF CONTENTS The object key name prefix or suffix identifying one or
more objects to which the filtering rule applies. The
Quickstart maximum length is 1,024 characters. Overlapping prefixes
(../../guide/quickstart.html) and suffixes are not supported. For more information, see
A Sample Tutorial Configuring Event Notifications
(../../guide/sqs.html) (https://docs.aws.amazon.com/AmazonS3/latest/dev/Notification
in the Amazon Simple Storage Service Developer Guide .
Code Examples
(../../guide/examples.html) Value (string) --
The value that the filter searches for in object key names.
User Guides
QueueConfigurations (list) --
The Amazon Simple Queue Service queues to publish messages to and
Available Services (index.html) the events for which to publish messages.
ACM (acm.html) (dict) --

Specifies the configuration for publishing messages to an Amazon
Simple Queue Service (Amazon SQS) queue when Amazon S3 detects
AlexaForBusiness specified events.
Id (string) --
Amplify (amplify.html) An optional unique identifier for configurations in a notification
configuration. If you don't provide one, Amazon S3 will assign an
APIGateway
ID.
(apigateway.html)
QueueArn (string) --
The Amazon Resource Name (ARN) of the Amazon SQS queue to
Api
which Amazon S3 publishes a message when it detects events of
the specified type.
api.html)
Events (list) --
Boto 3 Docs 1.9.249
(string) --
documentation ( The bucket event for which to send notifications.
../../index.html)
Filter (dict) --
Key (dict) --
TABLE OF CONTENTS FilterRules (list) --
(dict) --
Quickstart Specifies the Amazon S3 object key name to filter on and
(../../guide/quickstart.html) whether to filter on the suffix or prefix of the key name.
A Sample Tutorial Name (string) --
(../../guide/sqs.html) The object key name prefix or suffix identifying one or
Code Examples more objects to which the filtering rule applies. The
(../../guide/examples.html) maximum length is 1,024 characters. Overlapping prefixes
and suffixes are not supported. For more information, see
User Guides Configuring Event Notifications
(../../guide/index.html) (https://docs.aws.amazon.com/AmazonS3/latest/dev/Notification
Value (string) --
ACM (acm.html)
LambdaFunctionConfigurations (list) --
AlexaForBusiness Describes the AWS Lambda functions to invoke and the events for
(alexaforbusiness.html) which to invoke them.
Amplify (amplify.html) (dict) --

A container for specifying the configuration for AWS Lambda
APIGateway
notifications.
(apigateway.html)
Id (string) --
Api
ID.
api.html)
LambdaFunctionArn (string) --
Boto 3 Docs 1.9.249
The Amazon Resource Name (ARN) of the AWS Lambda function
documentation ( that Amazon S3 invokes when the specified event type occurs.
../../index.html)
Events (list) --
The Amazon S3 bucket event for which to invoke the AWS Lambda
TABLE OF CONTENTS function. For more information, see Supported Event Types
Quickstart in the Amazon Simple Storage Service Developer Guide .
(string) --
A Sample Tutorial The bucket event for which to send notifications.
Filter (dict) --
Code Examples Key (dict) --
(../../guide/examples.html) FilterRules (list) --
(dict) --
User Guides
Specifies the Amazon S3 object key name to filter on and
whether to filter on the suffix or prefix of the key name.
Available Services (index.html) Name (string) --
ACM (acm.html) The object key name prefix or suffix identifying one or
maximum length is 1,024 characters. Overlapping prefixes
AlexaForBusiness and suffixes are not supported. For more information, see
(alexaforbusiness.html) Configuring Event Notifications
(https://docs.aws.amazon.com/AmazonS3/latest/dev/Notification
APIGateway
Value (string) --
(apigateway.html)
Api
(apigatewaymanagement get_bucket_policy (**kwargs)
api.html) Returns the policy of a specified bucket.
Boto 3 Docs 1.9.249
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketPolicy)
documentation (
Request Syntax
../../index.html)
TABLE OF CONTENTS response = client.get_bucket_policy(

Bucket='string'
Quickstart )

User Guides Returns


{
ACM (acm.html)
'Policy': 'string'
AlexaForBusiness
Response Structure
(dict) --
APIGateway Policy (string) --
(apigateway.html) The bucket policy as a JSON document.
Api
get_bucket_policy_status (**kwargs)
api.html)
Retrieves the policy status for an Amazon S3 bucket, indicating whether the
Boto 3 Docs 1.9.249
bucket is public.
documentation (
../../index.html)
01/GetBucketPolicyStatus)
TABLE OF CONTENTS
Request Syntax
Quickstart
(../../guide/quickstart.html) response = client.get_bucket_policy_status(
A Sample Tutorial Bucket='string'

Code Examples
Bucket (string) --
User Guides
[REQUIRED]
The name of the Amazon S3 bucket whose policy status you want to
Available Services (index.html) retrieve.
ACM (acm.html) Return type
ACMPCA (acm-pca.html) dict
AlexaForBusiness Returns
(alexaforbusiness.html) Response Syntax
{
APIGateway
(apigateway.html) 'PolicyStatus': {
'IsPublic': True|False
Api
}
api.html)
Response Structure
Boto 3 Docs 1.9.249
PolicyStatus (dict) --
../../index.html)
The policy status for the specified bucket.
TABLE OF CONTENTS IsPublic (boolean) --

The policy status for this bucket. TRUE indicates that this bucket is
public. FALSE indicates that the bucket is not public.
Quickstart
A Sample Tutorial get_bucket_replication (**kwargs)

Returns the replication configuration of a bucket.
Code Examples
Note
User Guides It can take a while to propagate the put or delete a replication
(../../guide/index.html) configuration to all Amazon S3 systems. Therefore, a get request soon
Available Services (index.html) after put or delete can return a wrong result.
ACM (acm.html)
AlexaForBusiness 01/GetBucketReplication)
Request Syntax
APIGateway response = client.get_bucket_replication(

(apigateway.html) Bucket='string'
ApiGatewayManagement )
Api
Parameters
api.html)
Boto 3 Docs 1.9.249
../../index.html) dict
Returns
Quickstart
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'ReplicationConfiguration': {
../../index.html) 'Role': 'string',
'Rules': [
{
TABLE OF CONTENTS
'ID': 'string',
'Priority': 123,
Quickstart
'Prefix': 'string',
'Filter': {
(../../guide/sqs.html) 'Tag': {
Code Examples 'Key': 'string',
(../../guide/examples.html) 'Value': 'string'
},
User Guides
'And': {
'Prefix': 'string',
Available Services (index.html) 'Tags': [
{
ACM (acm.html)
'Key': 'string',
ACMPCA (acm-pca.html) 'Value': 'string'
},
AlexaForBusiness
(alexaforbusiness.html) ]
}
Amplify (amplify.html) },
APIGateway 'Status': 'Enabled'|'Disabled',
(apigateway.html) 'SourceSelectionCriteria': {
'SseKmsEncryptedObjects': {
'Status': 'Enabled'|'Disabled'
Api
}
api.html) },
'Destination': {
Boto 3 Docs 1.9.249
'Bucket': 'string',
documentation ( 'Account': 'string',
../../index.html) 'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY
'AccessControlTranslation': {
TABLE OF CONTENTS 'Owner': 'Destination'
},
Quickstart 'EncryptionConfiguration': {
(../../guide/quickstart.html) 'ReplicaKmsKeyID': 'string'
}
A Sample Tutorial
},
'DeleteMarkerReplication': {
Code Examples 'Status': 'Enabled'|'Disabled'
User Guides },
(../../guide/index.html) ]
}
ACM (acm.html)
Response Structure
AlexaForBusiness
(alexaforbusiness.html) (dict) --
ReplicationConfiguration (dict) --
Amplify (amplify.html) Role (string) --
APIGateway The Amazon Resource Name (ARN) of the AWS Identity and Access
(apigateway.html) Management (IAM) role that Amazon S3 assumes when replicating
objects. For more information, see How to Set Up Cross-Region
Replication (https://docs.aws.amazon.com/AmazonS3/latest/dev/crr-
Api
how-setup.html) in the Amazon Simple Storage Service Developer Guide
.
api.html)
Rules (list) --
Boto 3 Docs 1.9.249
A container for one or more replication rules. A replication
documentation ( configuration must have at least one rule and can contain a
../../index.html) maximum of 1,000 rules.
(dict) --
TABLE OF CONTENTS Specifies which Amazon S3 objects to replicate and where to store
the replicas.
Quickstart
ID (string) --
A unique identifier for the rule. The maximum value is 255
A Sample Tutorial characters.
Priority (integer) --
Code Examples The priority associated with the rule. If you specify multiple rules
(../../guide/examples.html) in a replication configuration, Amazon S3 prioritizes the rules to
prevent conflicts when filtering. If two or more rules identify the
User Guides
same object based on a specified filter, the rule with higher
priority takes precedence. For example:
Available Services (index.html) Same object quality prefix based filter criteria If prefixes you
ACM (acm.html) specified in multiple rules overlap
Same object qualify tag based filter criteria specified in
multiple rules
AlexaForBusiness For more information, see Cross-Region Replication (CRR)
(alexaforbusiness.html) (https://docs.aws.amazon.com/AmazonS3/latest/dev/crr.html) in
the Amazon S3 Developer Guide .
Prefix (string) --
APIGateway
An object keyname prefix that identifies the object or objects to
(apigateway.html)
which the rule applies. The maximum prefix length is 1,024
ApiGatewayManagement characters. To include all objects in a bucket, specify an empty
Api string.
Filter (dict) --
api.html)
Prefix (string) --
Boto 3 Docs 1.9.249
An object keyname prefix that identifies the subset of objects
documentation ( to which the rule applies.
../../index.html)
Tag (dict) --
A container for specifying a tag key and value.
TABLE OF CONTENTS
The rule applies only to objects that have the tag in their tag
set.
Quickstart
(../../guide/quickstart.html) Key (string) --
Name of the tag.
A Sample Tutorial
(../../guide/sqs.html) Value (string) --
Value of the tag.
Code Examples
(../../guide/examples.html) And (dict) --
A container for specifying rule filters. The filters determine the
User Guides
subset of objects to which the rule applies. This element is
required only if you specify more than one filter. For example:
Available Services (index.html) If you specify both a Prefix and a Tag filter, wrap these
ACM (acm.html) filters in an And tag.
If you specify a filter based on multiple tags, wrap the Tag
elements in an And tag.
AlexaForBusiness Prefix (string) --
(alexaforbusiness.html) Tags (list) --
(dict) --
Key (string) --
APIGateway Name of the tag.
(apigateway.html)
Value (string) --
ApiGatewayManagement Value of the tag.
Api
Status (string) --
Specifies whether the rule is enabled.
api.html)
SourceSelectionCriteria (dict) --
Boto 3 Docs 1.9.249
A container that describes additional filters for identifying the
documentation ( source objects that you want to replicate. You can choose to
../../index.html) enable or disable the replication of these objects. Currently,
Amazon S3 supports only the filter that you can specify for
TABLE OF CONTENTS objects created with server-side encryption using an AWS KMS-
Managed Key (SSE-KMS).
Quickstart SseKmsEncryptedObjects (dict) --
(../../guide/quickstart.html) A container for filter information for the selection of Amazon
A Sample Tutorial S3 objects encrypted with AWS KMS. If you include
(../../guide/sqs.html) SourceSelectionCriteria in the replication configuration, this
element is required.
Code Examples
(../../guide/examples.html) Status (string) --
Specifies whether Amazon S3 replicates objects created with
User Guides server-side encryption using an AWS KMS-managed key.
Available Services (index.html) A container for information about the replication destination.
ACM (acm.html) Bucket (string) --

The Amazon Resource Name (ARN) of the bucket where you
want Amazon S3 to store replicas of the object identified by
AlexaForBusiness the rule.
A replication configuration can replicate objects to only one
Amplify (amplify.html) destination bucket. If there are multiple rules in your
replication configuration, all rules must specify the same
APIGateway
destination bucket.
(apigateway.html)
Account (string) --
Destination bucket owner account ID. In a cross-account
Api
scenario, if you direct Amazon S3 to change replica ownership
to the AWS account that owns the destination bucket by
api.html)
specifying the AccessControlTranslation property, this is the
Boto 3 Docs 1.9.249
account ID of the destination bucket owner. For more
documentation ( information, see Cross-Region Replication Additional
../../index.html) Configuration: Change Replica Owner
(https://docs.aws.amazon.com/AmazonS3/latest/dev/crr-
TABLE OF CONTENTS change-owner.html) in the Amazon Simple Storage Service
Developer Guide .
Quickstart StorageClass (string) --
(../../guide/quickstart.html) The storage class to use when replicating objects, such as
A Sample Tutorial standard or reduced redundancy. By default, Amazon S3 uses
(../../guide/sqs.html) the storage class of the source object to create the object
replica.
Code Examples
(../../guide/examples.html) For valid values, see the StorageClass element of the PUT
Bucket replication
User Guides (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTr
(../../guide/index.html) action in the Amazon Simple Storage Service API Reference .
Available Services (index.html) AccessControlTranslation (dict) --

Specify this only in a cross-account scenario (where source and
ACM (acm.html)
destination bucket owners are not the same), and you want to
ACMPCA (acm-pca.html) change replica ownership to the AWS account that owns the
destination bucket. If this is not specified in the replication
AlexaForBusiness
configuration, the replicas are owned by same AWS account
that owns the source object.
Owner (string) --
APIGateway Specifies the replica ownership. For default and valid values,
(apigateway.html) see PUT bucket replication
ApiGatewayManagement (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPU
Api in the Amazon Simple Storage Service API Reference .
(apigatewaymanagement EncryptionConfiguration (dict) --
api.html)
A container that provides information about encryption. If
Boto 3 Docs 1.9.249
SourceSelectionCriteria is specified, you must specify this
documentation ( element.
../../index.html)
ReplicaKmsKeyID (string) --
Specifies the AWS KMS Key ID (Key ARN or Alias ARN) for the
TABLE OF CONTENTS destination bucket. Amazon S3 uses this key to encrypt
replica objects.
Quickstart
DeleteMarkerReplication (dict) --
Status (string) --
A Sample Tutorial The status of the delete marker replication.
Code Examples
Note
In the current implementation, Amazon S3 doesn't
User Guides replicate the delete markers. The status must be
(../../guide/index.html) Disabled .
ACM (acm.html)
get_bucket_request_payment (**kwargs)
Returns the request payment configuration of a bucket.
AlexaForBusiness
Amplify (amplify.html) 01/GetBucketRequestPayment)
APIGateway Request Syntax
(apigateway.html)
ApiGatewayManagement response = client.get_bucket_request_payment(

Api
Bucket='string'
)
api.html)
Parameters
Boto 3 Docs 1.9.249
documentation (
Return type
../../index.html)
dict

Response Syntax
Quickstart
{
A Sample Tutorial 'Payer': 'Requester'|'BucketOwner'
(../../guide/sqs.html) }
Code Examples
(../../guide/examples.html) Response Structure
User Guides (dict) --
(../../guide/index.html) Payer (string) --
Specifies who pays for the download and request fees.
ACM (acm.html)
get_bucket_tagging (**kwargs)
Returns the tag set associated with the bucket.
AlexaForBusiness
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketTagging)
Request Syntax
APIGateway
(apigateway.html)
response = client.get_bucket_tagging(
Bucket='string'
Api
)
api.html)
Parameters
Boto 3 Docs 1.9.249
documentation (
../../index.html) Return type
dict
Response Syntax
Quickstart
{
A Sample Tutorial 'TagSet': [
(../../guide/sqs.html) {
(../../guide/examples.html) 'Value': 'string'
},
User Guides ]
ACM (acm.html) Response Structure
ACMPCA (acm-pca.html) (dict) --

TagSet (list) --
AlexaForBusiness
(dict) --
Key (string) --
Amplify (amplify.html) Name of the tag.
APIGateway Value (string) --

(apigateway.html) Value of the tag.
Api
get_bucket_versioning (**kwargs)
api.html) Returns the versioning state of a bucket.
Boto 3 Docs 1.9.249
documentation ( 01/GetBucketVersioning)
../../index.html)
Request Syntax
TABLE OF CONTENTS
response = client.get_bucket_versioning(
Quickstart Bucket='string'
A Sample Tutorial
Code Examples
(../../guide/examples.html) Return type
dict
User Guides
Response Syntax
ACM (acm.html)
{
ACMPCA (acm-pca.html) 'Status': 'Enabled'|'Suspended',
AlexaForBusiness 'MFADelete': 'Enabled'|'Disabled'
Response Structure
APIGateway
(apigateway.html) (dict) --
Status (string) --
The versioning state of the bucket.
Api
(apigatewaymanagement MFADelete (string) --
api.html)
Specifies whether MFA delete is enabled in the bucket versioning
Boto 3 Docs 1.9.249
configuration. This element is only returned if the bucket has been
documentation ( configured with MFA delete. If the bucket has never been so
../../index.html) configured, this element is not returned.
TABLE OF CONTENTS
get_bucket_website (**kwargs)
Quickstart Returns the website configuration for a bucket.
A Sample Tutorial (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketWebsite)
Request Syntax
Code Examples
response = client.get_bucket_website(
User Guides Bucket='string'
(../../guide/index.html) )

Parameters
ACM (acm.html)
Return type
AlexaForBusiness dict
Returns
Response Syntax
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'RedirectAllRequestsTo': {
../../index.html) 'HostName': 'string',
'Protocol': 'http'|'https'
},
TABLE OF CONTENTS
'IndexDocument': {
'Suffix': 'string'
Quickstart
},
'ErrorDocument': {
A Sample Tutorial 'Key': 'string'
Code Examples 'RoutingRules': [
'Condition': {
User Guides
'HttpErrorCodeReturnedEquals': 'string',
'KeyPrefixEquals': 'string'
'Redirect': {
ACM (acm.html)
'HostName': 'string',
ACMPCA (acm-pca.html) 'HttpRedirectCode': 'string',
'Protocol': 'http'|'https',
AlexaForBusiness
(alexaforbusiness.html) 'ReplaceKeyPrefixWith': 'string',
'ReplaceKeyWith': 'string'
APIGateway },
(apigateway.html) ]
}
Api
(apigatewaymanagement Response Structure
api.html)
(dict) --
Boto 3 Docs 1.9.249
RedirectAllRequestsTo (dict) --
documentation ( HostName (string) --
../../index.html) Name of the host where requests are redirected.
Protocol (string) --
TABLE OF CONTENTS Protocol to use when redirecting requests. The default is the protocol
that is used in the original request.
Quickstart
IndexDocument (dict) --
Suffix (string) --
A Sample Tutorial A suffix that is appended to a request that is for a directory on the
(../../guide/sqs.html) website endpoint (e.g. if the suffix is index.html and you make a
Code Examples request to samplebucket/images/ the data that is returned will be for
(../../guide/examples.html) the object with the key name images/index.html) The suffix must not
be empty and must not include a slash character.
User Guides
ErrorDocument (dict) --
Key (string) --
Available Services (index.html) The object key name to use when a 4XX class error occurs.
ACM (acm.html) RoutingRules (list) --

(dict) --
Specifies the redirect behavior and when a redirect is applied.
AlexaForBusiness
Condition (dict) --
A container for describing a condition that must be met for the
Amplify (amplify.html) specified redirect to apply. For example, 1. If request is for pages in
the /docs folder, redirect to the /documents folder. 2. If request
APIGateway
results in HTTP error 4xx, redirect request to another host where
(apigateway.html)
you might process the error.
HttpErrorCodeReturnedEquals (string) --
Api
api.html)
The HTTP error code when the redirect is applied. In the event of
Boto 3 Docs 1.9.249
an error, if the error code equals this value, then the specified
documentation ( redirect is applied. Required when parent element Condition is
../../index.html) specified and sibling KeyPrefixEquals is not specified. If both are
specified, then both must be true for the redirect to be applied.
TABLE OF CONTENTS
KeyPrefixEquals (string) --
The object key name prefix when the redirect is applied. For
Quickstart example, to redirect requests for ExamplePage.html , the key
(../../guide/quickstart.html) prefix will be ExamplePage.html . To redirect request for all
A Sample Tutorial pages with the prefix docs/ , the key prefix will be /docs , which
(../../guide/sqs.html) identifies all objects in the docs/ folder. Required when the
parent element Condition is specified and sibling
Code Examples
HttpErrorCodeReturnedEquals is not specified. If both conditions
are specified, both must be true for the redirect to be applied.
User Guides
Redirect (dict) --
Container for redirect information. You can redirect requests to
Available Services (index.html) another host, to another page, or with another protocol. In the
event of an error, you can specify a different error code to return.
ACM (acm.html)
HostName (string) --
ACMPCA (acm-pca.html) The host name to use in the redirect request.
AlexaForBusiness HttpRedirectCode (string) --
(alexaforbusiness.html) The HTTP redirect code to use on the response. Not required if
Amplify (amplify.html) one of the siblings is present.
APIGateway Protocol (string) --

(apigateway.html) Protocol to use when redirecting requests. The default is the
protocol that is used in the original request.
Api ReplaceKeyPrefixWith (string) --
api.html)
The object key prefix to use in the redirect request. For example,
Boto 3 Docs 1.9.249
to redirect requests for all pages with prefix docs/ (objects in the
documentation ( docs/ folder) to documents/ , you can set a condition block with
../../index.html) KeyPrefixEquals set to docs/ and in the Redirect set
ReplaceKeyPrefixWith to /documents . Not required if one of the
TABLE OF CONTENTS siblings is present. Can be present only if ReplaceKeyWith is not
provided.
Quickstart
ReplaceKeyWith (string) --
The specific object key to use in the redirect request. For
A Sample Tutorial example, redirect request to error.html . Not required if one of
(../../guide/sqs.html) the siblings is present. Can be present only if
ReplaceKeyPrefixWith is not provided.
Code Examples
User Guides get_object (**kwargs)

(../../guide/index.html) Retrieves objects from Amazon S3.

(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObject)
ACM (acm.html)
Request Syntax
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.get_object(
../../index.html) IfMatch='string',
IfModifiedSince=datetime(2015, 1, 1),
IfNoneMatch='string',
TABLE OF CONTENTS
IfUnmodifiedSince=datetime(2015, 1, 1),
Key='string',
Quickstart
Range='string',
ResponseCacheControl='string',
A Sample Tutorial ResponseContentDisposition='string',
(../../guide/sqs.html) ResponseContentEncoding='string',
Code Examples ResponseContentLanguage='string',
(../../guide/examples.html) ResponseContentType='string',
ResponseExpires=datetime(2015, 1, 1),
User Guides
VersionId='string',
Available Services (index.html) SSECustomerKey='string',
RequestPayer='requester',
ACM (acm.html)
PartNumber=123
AlexaForBusiness
Amplify (amplify.html) Bucket (string) -- [REQUIRED]
IfMatch (string) -- Return the object only if its entity tag (ETag) is the same
APIGateway
as the one specified, otherwise return a 412 (precondition failed).
(apigateway.html)
IfModifiedSince (datetime) -- Return the object only if it has been
ApiGatewayManagement modified since the specified time, otherwise return a 304 (not modified).
Api IfNoneMatch (string) -- Return the object only if its entity tag (ETag) is
(apigatewaymanagement different from the one specified, otherwise return a 304 (not modified).
api.html)
IfUnmodifiedSince (datetime) -- Return the object only if it has not been
Boto 3 Docs 1.9.249
modified since the specified time, otherwise return a 412 (precondition
documentation ( failed).
../../index.html) Key (string) -- [REQUIRED]
Range (string) -- Downloads the specified range bytes of an object. For
TABLE OF CONTENTS more information about the HTTP Range header, go to
http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
Quickstart (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35).
(../../guide/quickstart.html) ResponseCacheControl (string) -- Sets the Cache-Control header of the
response.
A Sample Tutorial ResponseContentDisposition (string) -- Sets the Content-Disposition
(../../guide/sqs.html) header of the response
Code Examples ResponseContentEncoding (string) -- Sets the Content-Encoding header
(../../guide/examples.html) of the response.
ResponseContentLanguage (string) -- Sets the Content-Language header
User Guides of the response.
(../../guide/index.html) ResponseContentType (string) -- Sets the Content-Type header of the
response.
ResponseExpires (datetime) -- Sets the Expires header of the response.
ACM (acm.html) VersionId (string) -- VersionId used to reference a specific version of the
object.
AlexaForBusiness encrypting the object (e.g., AES256).
(alexaforbusiness.html) SSECustomerKey (string) -- Specifies the customer-provided encryption
Amplify (amplify.html) key for Amazon S3 to use in encrypting data. This value is used to store
the object and then it is discarded; Amazon does not store the encryption
APIGateway key. The key must be appropriate for use with the algorithm specified in
(apigateway.html) the x-amz-server-side-encryption-customer-algorithm header.
ApiGatewayManagement SSECustomerKeyMD5 (string) --
Api Specifies the 128-bit MD5 digest of the encryption key according to RFC
(apigatewaymanagement 1321. Amazon S3 uses this header for a message integrity check to
api.html) ensure the encryption key was transmitted without error.
Boto 3 Docs 1.9.249 Please note that this parameter is automatically populated if it is not
documentation ( provided. Including this parameter is not required
../../index.html)
TABLE OF CONTENTS he will be charged for the request. Bucket owners need not specify this
Quickstart from requester pays buckets can be found at
(../../guide/quickstart.html) http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
A Sample Tutorial
PartNumber (integer) -- Part number of the object being read. This is a
positive integer between 1 and 10,000. Effectively performs a 'ranged'
Code Examples GET request for the part specified. Useful for downloading just a part of
(../../guide/examples.html) an object.
User Guides Return type

(../../guide/index.html) dict
ACM (acm.html) Response Syntax
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'Body': StreamingBody(),
../../index.html) 'DeleteMarker': True|False,
'AcceptRanges': 'string',
TABLE OF CONTENTS
'Restore': 'string',
'LastModified': datetime(2015, 1, 1),
Quickstart
'ContentLength': 123,
'ETag': 'string',
A Sample Tutorial 'MissingMeta': 123,
(../../guide/sqs.html) 'VersionId': 'string',
Code Examples 'CacheControl': 'string',
(../../guide/examples.html) 'ContentDisposition': 'string',
'ContentEncoding': 'string',
User Guides
'ContentLanguage': 'string',
'ContentRange': 'string',
Available Services (index.html) 'ContentType': 'string',
'Expires': datetime(2015, 1, 1),
ACM (acm.html)
'WebsiteRedirectLocation': 'string',
ACMPCA (acm-pca.html) 'ServerSideEncryption': 'AES256'|'aws:kms',
'Metadata': {
AlexaForBusiness
(alexaforbusiness.html) 'string': 'string'
},
Amplify (amplify.html) 'SSECustomerAlgorithm': 'string',
APIGateway 'SSECustomerKeyMD5': 'string',
(apigateway.html) 'SSEKMSKeyId': 'string',
'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|
'RequestCharged': 'requester',
Api
'ReplicationStatus': 'COMPLETE'|'PENDING'|'FAILED'|'REPLICA',
api.html) 'PartsCount': 123,
'TagCount': 123,
Boto 3 Docs 1.9.249
'ObjectLockMode': 'GOVERNANCE'|'COMPLIANCE',
documentation ( 'ObjectLockRetainUntilDate': datetime(2015, 1, 1),
../../index.html) 'ObjectLockLegalHoldStatus': 'ON'|'OFF'
}
TABLE OF CONTENTS

(dict) --
A Sample Tutorial
(../../guide/sqs.html) Body ( StreamingBody ) --
Code Examples Object data.

(../../guide/examples.html) DeleteMarker (boolean) --
User Guides Specifies whether the object retrieved was (true) or was not (false) a
(../../guide/index.html) Delete Marker. If false, this response header does not appear in the
response.
AcceptRanges (string) --
ACM (acm.html)
If the object expiration is configured (see PUT Bucket lifecycle), the
AlexaForBusiness
response includes this header. It includes the expiry-date and rule-id
key value pairs providing object expiration information. The value of
Amplify (amplify.html) the rule-id is URL encoded.
APIGateway Restore (string) --

(apigateway.html)
Provides information about object restoration operation and expiration
ApiGatewayManagement time of the restored object copy.
Api
api.html) Last modified date of the object
ContentLength (integer) --
Boto 3 Docs 1.9.249
documentation ( Size of the body in bytes.
../../index.html) ETag (string) --
An ETag is an opaque identifier assigned by a web server to a specific

TABLE OF CONTENTS version of a resource found at a URL
MissingMeta (integer) --
Quickstart
(../../guide/quickstart.html) 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
A Sample Tutorial
SOAP that supports more flexible metadata than the REST API. For
example, using SOAP, you can create metadata whose values are not
Code Examples legal HTTP headers.
User Guides Version of the object.
CacheControl (string) --
Specifies caching behavior along the request/reply chain.
ACM (acm.html)
ContentDisposition (string) --
Specifies presentational information for the object.
AlexaForBusiness
ContentEncoding (string) --
Specifies what content encodings have been applied to the object and
thus what decoding mechanisms must be applied to obtain the media-
APIGateway type referenced by the Content-Type header field.
(apigateway.html)
ContentLanguage (string) --
The language the content is in.
Api
(apigatewaymanagement ContentRange (string) --
api.html)
The portion of the object returned in the response.
Boto 3 Docs 1.9.249
documentation ( ContentType (string) --
../../index.html) A standard MIME type describing the format of the object data.
Expires (datetime) --
TABLE OF CONTENTS
The date and time at which the object is no longer cacheable.
Quickstart WebsiteRedirectLocation (string) --

If the bucket is configured as a website, redirects requests for this
A Sample Tutorial object to another object in the same bucket or to an external URL.
(../../guide/sqs.html) Amazon S3 stores the value of this header in the object metadata.

(../../guide/index.html) Metadata (dict) --
Available Services (index.html) A map of metadata to store with the object in S3.
ACM (acm.html) (string) --
(string) --
AlexaForBusiness
Amplify (amplify.html) encryption algorithm used.
APIGateway SSECustomerKeyMD5 (string) --
(apigateway.html)
ApiGatewayManagement requested, the response will include this header to provide round trip
Api message integrity verification of the customer-provided encryption key.
api.html)
Boto 3 Docs 1.9.249
documentation (
StorageClass (string) --
../../index.html)
TABLE OF CONTENTS If present, indicates that the requester was successfully charged for the
request.
Quickstart
ReplicationStatus (string) --
PartsCount (integer) --
A Sample Tutorial
(../../guide/sqs.html) The count of parts this object has.
Code Examples TagCount (integer) --

The number of tags, if any, on the object.
User Guides ObjectLockMode (string) --
The object lock mode currently in place for this object.
ObjectLockRetainUntilDate (datetime) --
ACM (acm.html)
The date and time when this object's object lock will expire.
ObjectLockLegalHoldStatus (string) --
AlexaForBusiness
Indicates whether this object has an active legal hold. This field is only
returned if you have permission to view an object's legal hold status.
APIGateway
get_object_acl (**kwargs)
(apigateway.html)
Returns the access control list (ACL) of an object.
Api See also: AWS API Documentation
(apigatewaymanagement (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectAcl)
api.html) Request Syntax
Boto 3 Docs 1.9.249 response = client.get_object_acl(
VersionId='string',
TABLE OF CONTENTS
)
Quickstart
A Sample Tutorial Bucket (string) -- [REQUIRED]
(../../guide/sqs.html) Key (string) -- [REQUIRED]
Code Examples
object.
User Guides he will be charged for the request. Bucket owners need not specify this
(../../guide/index.html) parameter in their requests. Documentation on downloading objects
Available Services (index.html) http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
ACM (acm.html)
Return type
dict
AlexaForBusiness
Amplify (amplify.html) Response Syntax
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'Owner': {
../../index.html) 'DisplayName': 'string',
'ID': 'string'
},
TABLE OF CONTENTS
'Grants': [
{
Quickstart
'Grantee': {
A Sample Tutorial 'EmailAddress': 'string',
(../../guide/sqs.html) 'ID': 'string',
Code Examples 'Type': 'CanonicalUser'|'AmazonCustomerByEmail'|'G
(../../guide/examples.html) 'URI': 'string'
},
User Guides
'Permission': 'FULL_CONTROL'|'WRITE'|'WRITE_ACP'|'READ
},
Available Services (index.html) ],
ACM (acm.html)
}
AlexaForBusiness
(alexaforbusiness.html) Response Structure
APIGateway Owner (dict) --

(apigateway.html)
Api Grants (list) --
A list of grants.
api.html)
(dict) --
Boto 3 Docs 1.9.249
documentation ( Grantee (dict) --
../../index.html) DisplayName (string) --
Screen name of the grantee.

TABLE OF CONTENTS
Quickstart Email address of the grantee.

ID (string) --
A Sample Tutorial
Type (string) --
Code Examples
(../../guide/examples.html) Type of grantee
User Guides URI (string) --

(../../guide/index.html) URI of the grantee group.
Available Services (index.html) Permission (string) --
ACM (acm.html) Specifies the permission given to the grantee.
ACMPCA (acm-pca.html) RequestCharged (string) --
AlexaForBusiness If present, indicates that the requester was successfully charged for the
(alexaforbusiness.html) request.
APIGateway get_object_legal_hold (**kwargs)

(apigateway.html) Gets an object's current Legal Hold status.
ApiGatewayManagement See also: AWS API Documentation
Api (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-
(apigatewaymanagement 01/GetObjectLegalHold)
api.html)
Request Syntax
Boto 3 Docs 1.9.249
documentation (
response = client.get_object_legal_hold(
../../index.html)
Bucket='string',
Key='string',
TABLE OF CONTENTS
VersionId='string',
Quickstart
)
A Sample Tutorial
Parameters
Bucket (string) --
Code Examples [REQUIRED]
The bucket containing the object whose Legal Hold status you want to
User Guides retrieve.
Key (string) --
ACM (acm.html) The key name for the object whose Legal Hold status you want to
retrieve.
VersionId (string) -- The version ID of the object whose Legal Hold status
AlexaForBusiness
you want to retrieve.
Amplify (amplify.html) he will be charged for the request. Bucket owners need not specify this
APIGateway
(apigateway.html)
ApiGatewayManagement (http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
Api
Return type
api.html) dict
Returns
Boto 3 Docs 1.9.249
documentation ( Response Syntax
../../index.html)
{
TABLE OF CONTENTS 'LegalHold': {
'Status': 'ON'|'OFF'
Quickstart }
(../../guide/quickstart.html) }
A Sample Tutorial
(../../guide/sqs.html) Response Structure
Code Examples (dict) --

LegalHold (dict) --
User Guides The current Legal Hold status for the specified object.
Status (string) --
Indicates whether the specified object has a Legal Hold in place.
ACM (acm.html)
get_object_lock_configuration (**kwargs)
AlexaForBusiness
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
Amplify (amplify.html) specified bucket.

01/GetObjectLockConfiguration)
Api Request Syntax
api.html)
Boto 3 Docs 1.9.249 response = client.get_object_lock_configuration(
../../index.html) )

Bucket (string) --
The bucket whose object lock configuration you want to retrieve.
A Sample Tutorial
Return type
dict
Code Examples
Response Syntax
User Guides
{
Available Services (index.html) 'ObjectLockConfiguration': {
ACM (acm.html) 'ObjectLockEnabled': 'Enabled',
'Rule': {
'DefaultRetention': {
AlexaForBusiness 'Mode': 'GOVERNANCE'|'COMPLIANCE',
(alexaforbusiness.html) 'Days': 123,
'Years': 123
}
APIGateway }
(apigateway.html) }
Api
Response Structure
api.html)
(dict) --
Boto 3 Docs 1.9.249
ObjectLockConfiguration (dict) --
documentation ( The specified bucket's object lock configuration.
../../index.html)
ObjectLockEnabled (string) --
Indicates whether this bucket has an object lock configuration
TABLE OF CONTENTS enabled.
Rule (dict) --
Quickstart
The object lock rule in place for the specified object.
DefaultRetention (dict) --
A Sample Tutorial
The default retention period that you want to apply to new objects
placed in the specified bucket.
Code Examples
Mode (string) --
The default object lock retention mode you want to apply to new
User Guides objects placed in the specified bucket.
Days (integer) --
Available Services (index.html) The number of days that you want to specify for the default
retention period.
ACM (acm.html)
Years (integer) --
ACMPCA (acm-pca.html) The number of years that you want to specify for the default
AlexaForBusiness retention period.
get_object_retention (**kwargs)
APIGateway Retrieves an object's retention settings.
(apigateway.html)
ApiGatewayManagement (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-
Api 01/GetObjectRetention)
Request Syntax
api.html)
Boto 3 Docs 1.9.249 response = client.get_object_retention(
VersionId='string',
TABLE OF CONTENTS
)
Quickstart
A Sample Tutorial Bucket (string) --
(../../guide/sqs.html) [REQUIRED]
Code Examples The bucket containing the object whose retention settings you want to
(../../guide/examples.html) retrieve.
User Guides
Key (string) --
[REQUIRED]
The key name for the object whose retention settings you want to
retrieve.
ACM (acm.html)
VersionId (string) -- The version ID for the object whose retention settings
ACMPCA (acm-pca.html) you want to retrieve.
AlexaForBusiness
APIGateway
(apigateway.html)
Return type
Api dict
api.html)
Response Syntax
Boto 3 Docs 1.9.249
documentation (
{
../../index.html)
'Retention': {
'Mode': 'GOVERNANCE'|'COMPLIANCE',
TABLE OF CONTENTS
'RetainUntilDate': datetime(2015, 1, 1)
}
Quickstart
}
A Sample Tutorial
Response Structure
(dict) --
Code Examples
(../../guide/examples.html) Retention (dict) --
User Guides The container element for an object's retention settings.

(../../guide/index.html) Mode (string) --
Available Services (index.html) Indicates the Retention mode for the specified object.
ACM (acm.html) RetainUntilDate (datetime) --
ACMPCA (acm-pca.html) The date on which this object lock retention expires.
AlexaForBusiness
get_object_tagging (**kwargs)
Returns the tag-set of an object.
APIGateway
(apigateway.html)
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectTagging)
Request Syntax
Api
api.html)
Boto 3 Docs 1.9.249 response = client.get_object_tagging(
VersionId='string'
)
TABLE OF CONTENTS
Quickstart Parameters
(../../guide/quickstart.html) Bucket (string) -- [REQUIRED]
A Sample Tutorial Key (string) -- [REQUIRED]
(../../guide/sqs.html) VersionId (string) --

User Guides Returns


{
ACM (acm.html)
ACMPCA (acm-pca.html) 'TagSet': [
AlexaForBusiness {
(alexaforbusiness.html) 'Key': 'string',
'Value': 'string'
},
APIGateway ]
(apigateway.html) }
api.html) (dict) --
Boto 3 Docs 1.9.249
documentation ( TagSet (list) --
Key (string) --
TABLE OF CONTENTS
Name of the tag.
Quickstart Value (string) --

Value of the tag.
A Sample Tutorial
get_object_torrent (**kwargs)
Code Examples
(../../guide/examples.html) Return torrent files from a bucket.

User Guides
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectTorrent)
Request Syntax
ACM (acm.html)
response = client.get_object_torrent(
ACMPCA (acm-pca.html) Bucket='string',
Key='string',
AlexaForBusiness
)
APIGateway
Parameters
(apigateway.html)
ApiGatewayManagement Key (string) -- [REQUIRED]
Api RequestPayer (string) -- Confirms that the requester knows that she or
(apigatewaymanagement he will be charged for the request. Bucket owners need not specify this
api.html) parameter in their requests. Documentation on downloading objects
Boto 3 Docs 1.9.249
documentation ( (http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
../../index.html)
Return type
dict
TABLE OF CONTENTS
Returns
Quickstart Response Syntax
A Sample Tutorial {
(../../guide/sqs.html) 'Body': StreamingBody(),
Code Examples 'RequestCharged': 'requester'
User Guides
ACM (acm.html) Body ( StreamingBody ) --
ACMPCA (acm-pca.html) RequestCharged (string) --
AlexaForBusiness If present, indicates that the requester was successfully charged for the
(alexaforbusiness.html) request.
APIGateway get_paginator (operation_name)

(apigateway.html) Create a paginator for an operation.
ApiGatewayManagement Parameters
Api operation_name (string) -- The operation name. This is the same name as
(apigatewaymanagement the method name on the client. For example, if the method name is
api.html) create_foo , and you'd normally invoke the operation as
client.create_foo(**kwargs) , if the create_foo operation can be
Boto 3 Docs 1.9.249
paginated, you can use the call client.get_paginator("create_foo") .
documentation (
Raises OperationNotPageableError
../../index.html)
Raised if the operation is not pageable. You can use the
client.can_paginate method to check if an operation is pageable.
TABLE OF CONTENTS
Return type
Quickstart L{botocore.paginate.Paginator}
Returns
A Sample Tutorial A paginator object.
Code Examples
(../../guide/examples.html) get_public_access_block (**kwargs)
Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket.
User Guides
Available Services (index.html) 01/GetPublicAccessBlock)
AlexaForBusiness response = client.get_public_access_block(

(alexaforbusiness.html) Bucket='string'
)
APIGateway
Parameters
(apigateway.html)
Bucket (string) --
ApiGatewayManagement [REQUIRED]
Api
(apigatewaymanagement The name of the Amazon S3 bucket whose PublicAccessBlock
api.html) configuration you want to retrieve.
Return type
Boto 3 Docs 1.9.249
dict
documentation (
Returns
../../index.html)
Response Syntax
TABLE OF CONTENTS
{
Quickstart 'PublicAccessBlockConfiguration': {
(../../guide/quickstart.html) 'BlockPublicAcls': True|False,
'IgnorePublicAcls': True|False,
A Sample Tutorial
'BlockPublicPolicy': True|False,
'RestrictPublicBuckets': True|False
Code Examples }
User Guides
ACM (acm.html) PublicAccessBlockConfiguration (dict) --
The PublicAccessBlock configuration currently in effect for this
ACMPCA (acm-pca.html) Amazon S3 bucket.
AlexaForBusiness BlockPublicAcls (boolean) --
(alexaforbusiness.html) Specifies whether Amazon S3 should block public access control lists
Amplify (amplify.html) (ACLs) for this bucket and objects in this bucket. Setting this element
to TRUE causes the following behavior:
APIGateway
(apigateway.html) 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.
Api
Enabling this setting doesn't affect existing policies or ACLs.
api.html) IgnorePublicAcls (boolean) --
Specifies whether Amazon S3 should ignore public ACLs for this
Boto 3 Docs 1.9.249
bucket and objects in this bucket. Setting this element to TRUE causes
documentation ( Amazon S3 to ignore all public ACLs on this bucket and objects in this
../../index.html) bucket.
Enabling this setting doesn't affect the persistence of any existing

TABLE OF CONTENTS ACLs and doesn't prevent new public ACLs from being set.
BlockPublicPolicy (boolean) --
Quickstart
Specifies whether Amazon S3 should block public bucket policies for
this bucket. Setting this element to TRUE causes Amazon S3 to reject
A Sample Tutorial calls to PUT Bucket policy if the specified bucket policy allows public
(../../guide/sqs.html) access.
Code Examples Enabling this setting doesn't affect existing bucket policies.
RestrictPublicBuckets (boolean) --
User Guides Specifies whether Amazon S3 should restrict public bucket policies
(../../guide/index.html) for this bucket. Setting this element to TRUE restricts access to this
bucket to only AWS services and authorized users within this account
if the bucket has a public policy.
ACM (acm.html)
Enabling this setting doesn't affect previously stored bucket policies,
ACMPCA (acm-pca.html) except that public and cross-account access within any public bucket
policy, including non-public delegation to specific accounts, is
AlexaForBusiness
blocked.
APIGateway get_waiter (waiter_name)

(apigateway.html) Returns an object that can wait for some condition.
Api waiter_name (str) -- The name of the waiter to get. See the waiters section
(apigatewaymanagement of the service docs for a list of available waiters.
api.html)
Returns
Boto 3 Docs 1.9.249
The specified waiter object.
documentation (
botocore.waiter.Waiter
TABLE OF CONTENTS
head_bucket (**kwargs)
Quickstart
This operation is useful to determine if a bucket exists and you have permission
to access it.
A Sample Tutorial
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadBucket)
Code Examples
Request Syntax
User Guides
response = client.head_bucket(
Bucket='string'
ACM (acm.html)

AlexaForBusiness
None
APIGateway
(apigateway.html) head_object (**kwargs)
ApiGatewayManagement The HEAD operation retrieves metadata from an object without returning the
Api object itself. This operation is useful if you're only interested in an object's
(apigatewaymanagement metadata. To use HEAD, you must have READ access to the object.
api.html)
Boto 3 Docs 1.9.249
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadObject)
documentation (
Request Syntax
../../index.html)
TABLE OF CONTENTS response = client.head_object(

Bucket='string',
Quickstart IfMatch='string',
(../../guide/quickstart.html) IfModifiedSince=datetime(2015, 1, 1),
A Sample Tutorial
Key='string',
Code Examples Range='string',
(../../guide/examples.html) VersionId='string',
User Guides
Available Services (index.html) PartNumber=123
)
ACM (acm.html)
Parameters
AlexaForBusiness
Amplify (amplify.html) as the one specified, otherwise return a 412 (precondition failed).
APIGateway
modified since the specified time, otherwise return a 304 (not modified).
(apigateway.html)
IfNoneMatch (string) -- Return the object only if its entity tag (ETag) is
ApiGatewayManagement different from the one specified, otherwise return a 304 (not modified).
Api IfUnmodifiedSince (datetime) -- Return the object only if it has not been
(apigatewaymanagement modified since the specified time, otherwise return a 412 (precondition
api.html) failed).
Boto 3 Docs 1.9.249
documentation ( more information about the HTTP Range header, go to
../../index.html) http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
(http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35).
TABLE OF CONTENTS VersionId (string) -- VersionId used to reference a specific version of the
object.
Quickstart SSECustomerAlgorithm (string) -- Specifies the algorithm to use to when
(../../guide/quickstart.html) encrypting the object (e.g., AES256).
SSECustomerKey (string) -- Specifies the customer-provided encryption
A Sample Tutorial key for Amazon S3 to use in encrypting data. This value is used to store
(../../guide/sqs.html) the object and then it is discarded; Amazon does not store the encryption
Code Examples key. The key must be appropriate for use with the algorithm specified in
(../../guide/examples.html) the x-amz-server-side-encryption-customer-algorithm header.
User Guides Specifies the 128-bit MD5 digest of the encryption key according to RFC
(../../guide/index.html) 1321. Amazon S3 uses this header for a message integrity check to
ACM (acm.html)
Please note that this parameter is automatically populated if it is not
ACMPCA (acm-pca.html) provided. Including this parameter is not required
AlexaForBusiness
Amplify (amplify.html) he will be charged for the request. Bucket owners need not specify this
APIGateway
(apigateway.html)
ApiGatewayManagement (http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
Api PartNumber (integer) -- Part number of the object being read. This is a
(apigatewaymanagement positive integer between 1 and 10,000. Effectively performs a 'ranged'
api.html)
HEAD request for the part specified. Useful querying about the size of the
Boto 3 Docs 1.9.249
part and the number of parts in this object.
documentation (
Return type
../../index.html)
dict
Response Syntax
Quickstart
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'DeleteMarker': True|False,
../../index.html) 'AcceptRanges': 'string',
TABLE OF CONTENTS
Quickstart
'ETag': 'string',
'MissingMeta': 123,
A Sample Tutorial 'VersionId': 'string',
(../../guide/sqs.html) 'CacheControl': 'string',
Code Examples 'ContentDisposition': 'string',
(../../guide/examples.html) 'ContentEncoding': 'string',
User Guides
'ContentType': 'string',
Available Services (index.html) 'WebsiteRedirectLocation': 'string',
ACM (acm.html)
'Metadata': {
ACMPCA (acm-pca.html) 'string': 'string'
},
AlexaForBusiness
(alexaforbusiness.html) 'SSECustomerAlgorithm': 'string',
Amplify (amplify.html) 'SSEKMSKeyId': 'string',
APIGateway 'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|
(apigateway.html) 'RequestCharged': 'requester',
'PartsCount': 123,
Api
api.html) 'ObjectLockRetainUntilDate': datetime(2015, 1, 1),
'ObjectLockLegalHoldStatus': 'ON'|'OFF'
Boto 3 Docs 1.9.249
}
documentation (
../../index.html)
Response Structure
TABLE OF CONTENTS
(dict) --
Quickstart DeleteMarker (boolean) --
Specifies whether the object retrieved was (true) or was not (false) a
A Sample Tutorial Delete Marker. If false, this response header does not appear in the
(../../guide/sqs.html) response.
Code Examples AcceptRanges (string) --
User Guides If the object expiration is configured (see PUT Bucket lifecycle), the
(../../guide/index.html) response includes this header. It includes the expiry-date and rule-id
the rule-id is URL encoded.
ACM (acm.html)
Restore (string) --
AlexaForBusiness time of the restored object copy.
Last modified date of the object
APIGateway
(apigateway.html)
Size of the body in bytes.
Api ETag (string) --
api.html)
Boto 3 Docs 1.9.249
version of a resource found at a URL
documentation (
../../index.html)
This is set to the number of metadata entries not returned in x-amz-
TABLE OF CONTENTS meta headers. This can happen if you create metadata using an API like
Quickstart
legal HTTP headers.
A Sample Tutorial
(../../guide/sqs.html) Version of the object.
Code Examples CacheControl (string) --
User Guides ContentDisposition (string) --
ACM (acm.html)
ACMPCA (acm-pca.html) thus what decoding mechanisms must be applied to obtain the media-
AlexaForBusiness type referenced by the Content-Type header field.
(alexaforbusiness.html) ContentLanguage (string) --
Amplify (amplify.html) The language the content is in.
APIGateway ContentType (string) --
(apigateway.html)
A standard MIME type describing the format of the object data.
Api
(apigatewaymanagement The date and time at which the object is no longer cacheable.
api.html)
WebsiteRedirectLocation (string) --
Boto 3 Docs 1.9.249
documentation ( If the bucket is configured as a website, redirects requests for this
object to another object in the same bucket or to an external URL.
../../index.html)
Amazon S3 stores the value of this header in the object metadata.
TABLE OF CONTENTS ServerSideEncryption (string) --

Quickstart S3 (e.g., AES256, aws:kms).
Metadata (dict) --
A Sample Tutorial
A map of metadata to store with the object in S3.
(string) --
Code Examples
(string) --
Available Services (index.html) encryption algorithm used.
ACM (acm.html) SSECustomerKeyMD5 (string) --
ACMPCA (acm-pca.html) If server-side encryption with a customer-provided encryption key was

(apigateway.html)
Api RequestCharged (string) --
(apigatewaymanagement If present, indicates that the requester was successfully charged for the
api.html) request.
Boto 3 Docs 1.9.249
documentation ( PartsCount (integer) --
../../index.html) The count of parts this object has.
ObjectLockMode (string) --
TABLE OF CONTENTS
Quickstart ObjectLockRetainUntilDate (datetime) --

The date and time when this object's object lock expires.
A Sample Tutorial
The Legal Hold status for the specified object.
Code Examples
User Guides list_bucket_analytics_configurations (**kwargs)

(../../guide/index.html) Lists the analytics configurations for the bucket.

ACM (acm.html)
01/ListBucketAnalyticsConfigurations)
Request Syntax
AlexaForBusiness
response = client.list_bucket_analytics_configurations(
Amplify (amplify.html) Bucket='string',
ContinuationToken='string'
APIGateway
)
(apigateway.html)
Api Parameters
(apigatewaymanagement Bucket (string) --
api.html) [REQUIRED]
The name of the bucket from which analytics configurations are
Boto 3 Docs 1.9.249
retrieved.
documentation (
ContinuationToken (string) -- The ContinuationToken that represents a
../../index.html)
placeholder from where this request should begin.
TABLE OF CONTENTS Return type

dict
Quickstart Returns
Response Syntax
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'IsTruncated': True|False,
../../index.html) 'ContinuationToken': 'string',
'NextContinuationToken': 'string',
'AnalyticsConfigurationList': [
TABLE OF CONTENTS
{
'Id': 'string',
Quickstart
'Filter': {
'Prefix': 'string',
A Sample Tutorial 'Tag': {
(../../guide/sqs.html) 'Key': 'string',
Code Examples 'Value': 'string'
'And': {
User Guides
'Prefix': 'string',
'Tags': [
'Key': 'string',
ACM (acm.html)
'Value': 'string'
]
AlexaForBusiness
},
Amplify (amplify.html) 'StorageClassAnalysis': {
APIGateway 'DataExport': {
(apigateway.html) 'OutputSchemaVersion': 'V_1',
'Destination': {
Api
'Format': 'CSV',
api.html) 'BucketAccountId': 'string',
'Bucket': 'string',
Boto 3 Docs 1.9.249
'Prefix': 'string'
documentation ( }
../../index.html) }
}
TABLE OF CONTENTS }
},
Quickstart ]
A Sample Tutorial
IsTruncated (boolean) --
User Guides
Indicates whether the returned list of analytics configurations is
complete. A value of true indicates that the list is not complete and the
Available Services (index.html) NextContinuationToken will be provided for a subsequent request.
ACM (acm.html) ContinuationToken (string) --
ACMPCA (acm-pca.html) The ContinuationToken that represents where this request began.
AlexaForBusiness NextContinuationToken (string) --

(alexaforbusiness.html) NextContinuationToken is sent when isTruncated is true, which
Amplify (amplify.html) indicates that there are more analytics configurations to list. The next
request must include this NextContinuationToken. The token is
APIGateway
obfuscated and is not a usable value.
(apigateway.html)
AnalyticsConfigurationList (list) --
Api The list of analytics configurations for a bucket.
(apigatewaymanagement (dict) --
api.html)
Specifies the configuration and any analyses for the analytics filter of
Boto 3 Docs 1.9.249
an Amazon S3 bucket.
documentation (
For more information, see GET Bucket analytics
../../index.html)
(https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETAnalyti
in the Amazon Simple Storage Service API Reference .
TABLE OF CONTENTS
Id (string) --
Quickstart The ID that identifies the analytics configuration.
Filter (dict) --
A Sample Tutorial
The filter used to describe a set of objects for analyses. A filter
must have exactly one prefix, one tag, or one conjunction
Code Examples (AnalyticsAndOperator). If no filter is provided, all objects will be
(../../guide/examples.html) considered in any analysis.
User Guides Prefix (string) --

(../../guide/index.html) The prefix to use when evaluating an analytics filter.
Available Services (index.html) Tag (dict) --
ACM (acm.html) The tag to use when evaluating an analytics filter.
ACMPCA (acm-pca.html) Key (string) --
AlexaForBusiness Name of the tag.
Value (string) --
Value of the tag.
APIGateway
And (dict) --
(apigateway.html)
evaluating an analytics filter. The operator must have at least
Api
two predicates.
api.html) Prefix (string) --
The prefix to use when evaluating an AND predicate: The
Boto 3 Docs 1.9.249
prefix that an object must have to be included in the metrics
documentation ( results.
../../index.html)
Tags (list) --
TABLE OF CONTENTS The list of tags to use when evaluating an AND predicate.
(dict) --
Quickstart
Key (string) --
Name of the tag.
A Sample Tutorial
Code Examples Value of the tag.

StorageClassAnalysis (dict) --
User Guides Contains data related to access patterns to be collected and made
(../../guide/index.html) available to analyze the tradeoffs between different storage
classes.
DataExport (dict) --
ACM (acm.html)
Specifies how data related to the storage class analysis for an
Amazon S3 bucket should be exported.
AlexaForBusiness
OutputSchemaVersion (string) --
The version of the output schema to use when exporting data.
Must be V_1 .
APIGateway
(apigateway.html)
Api S3BucketDestination (dict) --
A destination signifying output to an S3 bucket.
api.html)
Format (string) --
Boto 3 Docs 1.9.249
documentation ( Specifies the file format used when exporting data to
Amazon S3.
../../index.html)
BucketAccountId (string) --
TABLE OF CONTENTS The account ID that owns the destination bucket. If no
account ID is provided, the owner will not be validated
Quickstart prior to exporting data.
Bucket (string) --
A Sample Tutorial
The Amazon Resource Name (ARN) of the bucket to which
data is exported.
Code Examples
Prefix (string) --
The prefix to use when exporting data. The prefix is
User Guides prepended to all results.

list_bucket_inventory_configurations (**kwargs)
ACM (acm.html)
Returns a list of inventory configurations for the bucket.
(alexaforbusiness.html) 01/ListBucketInventoryConfigurations)
APIGateway
(apigateway.html) response = client.list_bucket_inventory_configurations(
Bucket='string',
Api ContinuationToken='string'
api.html)
Parameters
Boto 3 Docs 1.9.249
Bucket (string) --
documentation (
[REQUIRED]
../../index.html)
The name of the bucket containing the inventory configurations to
retrieve.
TABLE OF CONTENTS
ContinuationToken (string) -- The marker used to continue an inventory
Quickstart configuration listing that has been truncated. Use the
(../../guide/quickstart.html) NextContinuationToken from a previously truncated list response to
continue the listing. The continuation token is an opaque value that
A Sample Tutorial Amazon S3 understands.
Return type
Code Examples
dict
Returns
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'ContinuationToken': 'string',
../../index.html) 'InventoryConfigurationList': [
{
'Destination': {
TABLE OF CONTENTS
Quickstart
'Bucket': 'string',
(../../guide/sqs.html) 'Encryption': {
Code Examples 'SSES3': {},
(../../guide/examples.html) 'SSEKMS': {
'KeyId': 'string'
User Guides
}
}
},
ACM (acm.html)
'IsEnabled': True|False,
ACMPCA (acm-pca.html) 'Filter': {
'Prefix': 'string'
AlexaForBusiness
'Id': 'string',
Amplify (amplify.html) 'IncludedObjectVersions': 'All'|'Current',
APIGateway 'OptionalFields': [
(apigateway.html) 'Size'|'LastModifiedDate'|'StorageClass'|'ETag'|'I
],
'Schedule': {
Api
'Frequency': 'Daily'|'Weekly'
api.html) }
},
Boto 3 Docs 1.9.249
],
../../index.html) 'NextContinuationToken': 'string'
}
TABLE OF CONTENTS

(dict) --
A Sample Tutorial
(../../guide/sqs.html) ContinuationToken (string) --
Code Examples If sent in the request, the marker that is used as a starting point for this
(../../guide/examples.html) inventory configuration list response.
InventoryConfigurationList (list) --
User Guides
(../../guide/index.html) The list of inventory configurations for a bucket.
ACM (acm.html) Specifies the inventory configuration for an Amazon S3 bucket. For
more information, see GET Bucket inventory
ACMPCA (acm-pca.html) (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInvento
AlexaForBusiness in the Amazon Simple Storage Service API Reference .
(alexaforbusiness.html) Destination (dict) --
Amplify (amplify.html) Contains information about where to publish the inventory results.
APIGateway S3BucketDestination (dict) --
(apigateway.html)
Contains the bucket name, file format, bucket owner (optional),
ApiGatewayManagement and prefix (optional) where inventory results are published.
Api
(apigatewaymanagement AccountId (string) --
api.html) The ID of the account that owns the destination bucket.
Bucket (string) --
Boto 3 Docs 1.9.249
documentation ( The Amazon resource name (ARN) of the bucket where
inventory results will be published.
../../index.html)
Format (string) --
TABLE OF CONTENTS Specifies the output format of the inventory results.
Prefix (string) --
Quickstart
(../../guide/quickstart.html) The prefix that is prepended to all inventory results.
A Sample Tutorial Encryption (dict) --

Contains the type of server-side encryption used to encrypt
Code Examples the inventory results.
SSES3 (dict) --
User Guides Specifies the use of SSE-S3 to encrypt delivered Inventory
(../../guide/index.html) reports.
Available Services (index.html) SSEKMS (dict) --
ACM (acm.html) Specifies the use of SSE-KMS to encrypt delivered Inventory
reports.
KeyId (string) --
AlexaForBusiness
(alexaforbusiness.html) Specifies the ID of the AWS Key Management Service
(KMS) master encryption key to use for encrypting
Inventory reports.
APIGateway
IsEnabled (boolean) --
(apigateway.html)
Specifies whether the inventory is enabled or disabled. If set to
True , an inventory list is generated. If set to False , no inventory
Api
list is generated.
api.html) Filter (dict) --
Specifies an inventory filter. The inventory only includes objects
Boto 3 Docs 1.9.249
that meet the filter's criteria.
documentation (
Prefix (string) --
../../index.html)
The prefix that an object must have to be included in the
TABLE OF CONTENTS inventory results.
Id (string) --
Quickstart
The ID used to identify the inventory configuration.
IncludedObjectVersions (string) --
A Sample Tutorial
(../../guide/sqs.html) Object versions to include in the inventory list. If set to All , the list
includes all the object versions, which adds the version-related
Code Examples
fields VersionId , IsLatest , and DeleteMarker to the list. If set to
Current , the list does not contain these version-related fields.
User Guides
Contains the optional fields that are included in the inventory
Available Services (index.html) results.
ACMPCA (acm-pca.html) Schedule (dict) --
AlexaForBusiness Specifies the schedule for generating inventory results.

(alexaforbusiness.html) Frequency (string) --
Amplify (amplify.html) Specifies how frequently inventory results are produced.
APIGateway IsTruncated (boolean) --
(apigateway.html)
Indicates whether the returned list of inventory configurations is
ApiGatewayManagement truncated in this response. A value of true indicates that the list is
Api truncated.
api.html) NextContinuationToken (string) --
The marker used to continue this inventory configuration listing. Use
Boto 3 Docs 1.9.249
the NextContinuationToken from this response to continue the listing
documentation ( in a subsequent request. The continuation token is an opaque value
../../index.html) that Amazon S3 understands.
TABLE OF CONTENTS
list_bucket_metrics_configurations (**kwargs)
Quickstart Lists the metrics configurations for the bucket.
A Sample Tutorial (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-
(../../guide/sqs.html) 01/ListBucketMetricsConfigurations)
Code Examples Request Syntax

User Guides response = client.list_bucket_metrics_configurations(

(../../guide/index.html) Bucket='string',
ContinuationToken='string'
ACM (acm.html)

AlexaForBusiness Bucket (string) --
(alexaforbusiness.html) [REQUIRED]
Amplify (amplify.html) The name of the bucket containing the metrics configurations to retrieve.
APIGateway ContinuationToken (string) -- The marker that is used to continue a

(apigateway.html) metrics configuration listing that has been truncated. Use the
NextContinuationToken from a previously truncated list response to
ApiGatewayManagement continue the listing. The continuation token is an opaque value that
Api Amazon S3 understands.
api.html) Return type
dict
Boto 3 Docs 1.9.249
documentation ( Returns
../../index.html) Response Syntax
TABLE OF CONTENTS
Quickstart
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
../../index.html) 'ContinuationToken': 'string',
'MetricsConfigurationList': [
TABLE OF CONTENTS
{
'Id': 'string',
Quickstart
'Filter': {
'Prefix': 'string',
A Sample Tutorial 'Tag': {
(../../guide/sqs.html) 'Key': 'string',
Code Examples 'Value': 'string'
'And': {
User Guides
'Prefix': 'string',
'Tags': [
'Key': 'string',
ACM (acm.html)
'Value': 'string'
]
AlexaForBusiness
}
APIGateway ]
(apigateway.html) }
(dict) --
api.html)
Boto 3 Docs 1.9.249
documentation ( Indicates whether the returned list of metrics configurations is
complete. A value of true indicates that the list is not complete and the
../../index.html)
NextContinuationToken will be provided for a subsequent request.
TABLE OF CONTENTS ContinuationToken (string) --
The marker that is used as a starting point for this metrics

Quickstart configuration list response. This value is present if it was sent in the
(../../guide/quickstart.html) request.
A Sample Tutorial NextContinuationToken (string) --
The marker used to continue a metrics configuration listing that has
Code Examples been truncated. Use the NextContinuationToken from a previously
(../../guide/examples.html) truncated list response to continue the listing. The continuation token
is an opaque value that Amazon S3 understands.
User Guides
(../../guide/index.html) MetricsConfigurationList (list) --
Available Services (index.html) The list of metrics configurations for a bucket.
ACMPCA (acm-pca.html) Specifies a metrics configuration for the CloudWatch request metrics
(specified by the metrics configuration ID) from an Amazon S3
AlexaForBusiness bucket. If you're updating an existing metrics configuration, note that
(alexaforbusiness.html) this is a full replacement of the existing metrics configuration. If you
Amplify (amplify.html) don't include the elements you want to keep, they are erased. For
more information, see PUT Bucket metrics
APIGateway (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricC
(apigateway.html) in the Amazon Simple Storage Service API Reference .
ApiGatewayManagement Id (string) --
Api
(apigatewaymanagement The ID used to identify the metrics configuration.
api.html) Filter (dict) --
Specifies a metrics configuration filter. The metrics configuration
Boto 3 Docs 1.9.249
will only include objects that meet the filter's criteria. A filter must
documentation ( be a prefix, a tag, or a conjunction (MetricsAndOperator).
../../index.html)
Prefix (string) --
TABLE OF CONTENTS The prefix used when evaluating a metrics filter.
Tag (dict) --
Quickstart
The tag used when evaluating a metrics filter.
Key (string) --
A Sample Tutorial
(../../guide/sqs.html) Name of the tag.
Code Examples Value (string) --

Value of the tag.
User Guides And (dict) --
Available Services (index.html) evaluating a metrics filter. The operator must have at least two
predicates, and an object must match all of the predicates in
ACM (acm.html)
order for the filter to apply.
Prefix (string) --
AlexaForBusiness
The prefix used when evaluating an AND predicate.
Tags (list) --
The list of tags used when evaluating an AND predicate.
APIGateway
ApiGatewayManagement Key (string) --
Api
Name of the tag.
api.html) Value (string) --
Value of the tag.
Boto 3 Docs 1.9.249
documentation (
../../index.html) list_buckets ()
Returns a list of all buckets owned by the authenticated sender of the request.
TABLE OF CONTENTS
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBuckets)
Quickstart
A Sample Tutorial
(../../guide/sqs.html) response = client.list_buckets()
Code Examples
dict
User Guides
Response Syntax
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'Buckets': [
../../index.html) {
'Name': 'string',
'CreationDate': datetime(2015, 1, 1)
TABLE OF CONTENTS
},
],
Quickstart
'Owner': {
A Sample Tutorial 'ID': 'string'
Code Examples }

Available Services (index.html) Buckets (list) --
(dict) --
ACM (acm.html) Name (string) --
ACMPCA (acm-pca.html) The name of the bucket.
AlexaForBusiness CreationDate (datetime) --

(alexaforbusiness.html) Date the bucket was created.
Amplify (amplify.html) Owner (dict) --

APIGateway ID (string) --
(apigateway.html)
Api list_multipart_uploads (**kwargs)
(apigatewaymanagement This operation lists in-progress multipart uploads.
api.html)
Boto 3 Docs 1.9.249
documentation ( 01/ListMultipartUploads)
../../index.html)
Request Syntax
TABLE OF CONTENTS
response = client.list_multipart_uploads(
(../../guide/quickstart.html) Delimiter='string',
EncodingType='url',
A Sample Tutorial
KeyMarker='string',
MaxUploads=123,
Code Examples Prefix='string',
(../../guide/examples.html) UploadIdMarker='string'
)
User Guides
Parameters
ACM (acm.html) Delimiter (string) -- Character you use to group keys.
ACMPCA (acm-pca.html) EncodingType (string) -- Requests Amazon S3 to encode the object keys
in the response and specifies the encoding method to use. An object key
AlexaForBusiness may contain any Unicode character; however, XML 1.0 parser cannot
(alexaforbusiness.html) parse some characters, such as characters with an ASCII value from 0 to
Amplify (amplify.html) 10. For characters that are not supported in XML 1.0, you can add this
parameter to request that Amazon S3 encode the keys in the response.
APIGateway KeyMarker (string) -- Together with upload-id-marker, this parameter
(apigateway.html) specifies the multipart upload after which listing should begin.
ApiGatewayManagement MaxUploads (integer) -- Sets the maximum number of multipart uploads,
Api from 1 to 1,000, to return in the response body. 1,000 is the maximum
(apigatewaymanagement number of uploads that can be returned in a response.
api.html)
Prefix (string) -- Lists in-progress uploads only for those keys that begin
Boto 3 Docs 1.9.249
with the specified prefix.
documentation ( UploadIdMarker (string) -- Together with key-marker, specifies the
../../index.html) multipart upload after which listing should begin. If key-marker is not
specified, the upload-id-marker parameter is ignored.
dict
Quickstart
(../../guide/quickstart.html) Returns
A Sample Tutorial Response Syntax

Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'Bucket': 'string',
../../index.html) 'KeyMarker': 'string',
'UploadIdMarker': 'string',
'NextKeyMarker': 'string',
TABLE OF CONTENTS
'Prefix': 'string',
'Delimiter': 'string',
Quickstart
'NextUploadIdMarker': 'string',
'MaxUploads': 123,
A Sample Tutorial 'IsTruncated': True|False,
(../../guide/sqs.html) 'Uploads': [
Code Examples {
(../../guide/examples.html) 'UploadId': 'string',
'Key': 'string',
User Guides
'Initiated': datetime(2015, 1, 1),
'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'STAND
Available Services (index.html) 'Owner': {
ACM (acm.html)
'ID': 'string'
'Initiator': {
AlexaForBusiness
(alexaforbusiness.html) 'ID': 'string',
'DisplayName': 'string'
APIGateway },
(apigateway.html) ],
'CommonPrefixes': [
{
Api
'Prefix': 'string'
api.html) },
],
Boto 3 Docs 1.9.249
'EncodingType': 'url'
documentation ( }
../../index.html)
TABLE OF CONTENTS Response Structure
(dict) --
Quickstart
(../../guide/quickstart.html) Bucket (string) --
A Sample Tutorial Name of the bucket to which the multipart upload was initiated.
KeyMarker (string) --
Code Examples
The key at or after which the listing began.
UploadIdMarker (string) --
User Guides
(../../guide/index.html) Upload ID after which listing began.
NextKeyMarker (string) --
When a list is truncated, this element specifies the value that should be
ACM (acm.html)
used for the key-marker request parameter in a subsequent request.
Prefix (string) --
AlexaForBusiness
When a prefix is provided in the request, this field contains the
specified prefix. The result contains only keys starting with the
Amplify (amplify.html) specified prefix.
APIGateway Delimiter (string) --
(apigateway.html)
NextUploadIdMarker (string) --
When a list is truncated, this element specifies the value that should be
Api
used for the upload-id-marker request parameter in a subsequent
request.
api.html)
MaxUploads (integer) --
Boto 3 Docs 1.9.249
documentation ( Maximum number of multipart uploads that could have been included
in the response.
../../index.html)
TABLE OF CONTENTS Indicates whether the returned list of multipart uploads is truncated. A
value of true indicates that the list was truncated. The list can be
Quickstart truncated if the number of multipart uploads exceeds the limit allowed
(../../guide/quickstart.html) or specified by max uploads.
A Sample Tutorial Uploads (list) --
(dict) --
Code Examples
User Guides
(../../guide/index.html) Key (string) --
Key of the object for which the multipart upload was initiated.
Initiated (datetime) --
ACM (acm.html)
Date and time at which the multipart upload was initiated.
AlexaForBusiness
Amplify (amplify.html) Owner (dict) --
APIGateway DisplayName (string) --
(apigateway.html) ID (string) --
Initiator (dict) --
Api Identifies who initiated the multipart upload.
ID (string) --
api.html)
If the principal is an AWS account, it provides the Canonical User
Boto 3 Docs 1.9.249
ID. If the principal is an IAM User, it provides a user ARN value.
documentation (
../../index.html)
Name of the Principal.
TABLE OF CONTENTS CommonPrefixes (list) --
(dict) --
Quickstart
Prefix (string) --
EncodingType (string) --
A Sample Tutorial
Encoding type used by Amazon S3 to encode object keys in the
response.
Code Examples
list_object_versions (**kwargs)
User Guides
Returns metadata about all of the versions of objects in a bucket.
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectVersions)
ACM (acm.html)
Request Syntax
AlexaForBusiness response = client.list_object_versions(

(alexaforbusiness.html) Bucket='string',
Amplify (amplify.html) Delimiter='string',
EncodingType='url',
APIGateway KeyMarker='string',
(apigateway.html)
MaxKeys=123,
ApiGatewayManagement Prefix='string',
Api VersionIdMarker='string'
api.html)
Parameters
Boto 3 Docs 1.9.249
documentation ( Delimiter (string) -- A delimiter is a character you use to group keys.
../../index.html) EncodingType (string) -- Requests Amazon S3 to encode the object keys
TABLE OF CONTENTS may contain any Unicode character; however, XML 1.0 parser cannot
parse some characters, such as characters with an ASCII value from 0 to
Quickstart 10. For characters that are not supported in XML 1.0, you can add this
(../../guide/quickstart.html) parameter to request that Amazon S3 encode the keys in the response.
KeyMarker (string) -- Specifies the key to start with when listing objects in
A Sample Tutorial
a bucket.
MaxKeys (integer) -- Sets the maximum number of keys returned in the
Code Examples response. The response might contain fewer keys but will never contain
(../../guide/examples.html) more.
Prefix (string) -- Limits the response to keys that begin with the specified
User Guides prefix.
(../../guide/index.html) VersionIdMarker (string) -- Specifies the object version you want to start
listing from.
Return type
ACM (acm.html)
dict
Returns
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
'VersionIdMarker': 'string',
'NextKeyMarker': 'string',
TABLE OF CONTENTS
'NextVersionIdMarker': 'string',
'Versions': [
Quickstart
{
'ETag': 'string',
A Sample Tutorial 'Size': 123,
(../../guide/sqs.html) 'StorageClass': 'STANDARD',
(../../guide/examples.html) 'VersionId': 'string',
'IsLatest': True|False,
User Guides
'Owner': {
Available Services (index.html) 'DisplayName': 'string',
'ID': 'string'
ACM (acm.html)
}
],
AlexaForBusiness
(alexaforbusiness.html) 'DeleteMarkers': [
{
Amplify (amplify.html) 'Owner': {
APIGateway 'DisplayName': 'string',
(apigateway.html) 'ID': 'string'
},
'Key': 'string',
Api
api.html) 'IsLatest': True|False,
'LastModified': datetime(2015, 1, 1)
Boto 3 Docs 1.9.249
},
documentation ( ],
../../index.html) 'Name': 'string',
'Prefix': 'string',
TABLE OF CONTENTS 'Delimiter': 'string',
'MaxKeys': 123,
Quickstart 'CommonPrefixes': [
(../../guide/quickstart.html) {
'Prefix': 'string'
A Sample Tutorial
},
],
Code Examples 'EncodingType': 'url'
User Guides
ACM (acm.html) IsTruncated (boolean) --
ACMPCA (acm-pca.html) A flag that indicates whether or not Amazon S3 returned all of the
AlexaForBusiness results that satisfied the search criteria. If your results were truncated,
(alexaforbusiness.html) you can make a follow-up paginated request using the NextKeyMarker
and NextVersionIdMarker response parameters as a starting place in
Amplify (amplify.html) another request to return the rest of the results.
APIGateway KeyMarker (string) --
(apigateway.html)
Marks the last Key returned in a truncated response.
Api VersionIdMarker (string) --
(apigatewaymanagement NextKeyMarker (string) --
api.html)
Use this value for the key marker request parameter in a subsequent
Boto 3 Docs 1.9.249
request.
documentation (
NextVersionIdMarker (string) --
../../index.html)
Use this value for the next version id marker parameter in a
TABLE OF CONTENTS subsequent request.
Versions (list) --
Quickstart
(dict) --
ETag (string) --
A Sample Tutorial
(../../guide/sqs.html) Size (integer) --
Code Examples Size in bytes of the object.

User Guides The class of storage used to store the object.
Key (string) --
The object key.
ACM (acm.html)
Version ID of an object.
AlexaForBusiness
IsLatest (boolean) --
Specifies whether the object is (true) or is not (false) the latest
version of an object.
APIGateway
(apigateway.html)
Date and time the object was last modified.
Api Owner (dict) --
api.html)
ID (string) --
Boto 3 Docs 1.9.249
DeleteMarkers (list) --
documentation (
(dict) --
../../index.html)
Owner (dict) --
TABLE OF CONTENTS DisplayName (string) --
ID (string) --
Quickstart Key (string) --
The object key.
A Sample Tutorial
Code Examples
(../../guide/examples.html) IsLatest (boolean) --
User Guides Specifies whether the object is (true) or is not (false) the latest
(../../guide/index.html) version of an object.
ACM (acm.html)
Name (string) --
Prefix (string) --
AlexaForBusiness
(alexaforbusiness.html) Delimiter (string) --
Amplify (amplify.html) MaxKeys (integer) --
APIGateway CommonPrefixes (list) --
(apigateway.html)
(dict) --
ApiGatewayManagement Prefix (string) --
Api EncodingType (string) --
api.html)
Boto 3 Docs 1.9.249
response.
documentation (
../../index.html)
list_objects (**kwargs)
TABLE OF CONTENTS Returns some or all (up to 1000) of the objects in a bucket. You can use the
request parameters as selection criteria to return a subset of the objects in a
Quickstart bucket.
A Sample Tutorial (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjects)
Request Syntax
Code Examples
response = client.list_objects(
(../../guide/index.html) Delimiter='string',
EncodingType='url',
Available Services (index.html) Marker='string',
ACM (acm.html) MaxKeys=123,
Prefix='string',
AlexaForBusiness )

APIGateway Bucket (string) -- [REQUIRED]
(apigateway.html) Delimiter (string) -- A delimiter is a character you use to group keys.
EncodingType (string) -- Requests Amazon S3 to encode the object keys
Api
may contain any Unicode character; however, XML 1.0 parser cannot
api.html)
10. For characters that are not supported in XML 1.0, you can add this
Boto 3 Docs 1.9.249
parameter to request that Amazon S3 encode the keys in the response.
documentation ( Marker (string) -- Specifies the key to start with when listing objects in a
../../index.html) bucket.
MaxKeys (integer) -- Sets the maximum number of keys returned in the
TABLE OF CONTENTS response. The response might contain fewer keys but will never contain
more.
Quickstart Prefix (string) -- Limits the response to keys that begin with the specified
(../../guide/quickstart.html) prefix.
A Sample Tutorial he will be charged for the list objects request. Bucket owners need not
(../../guide/sqs.html) specify this parameter in their requests.
dict
User Guides Returns
Response Syntax
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
../../index.html) 'Marker': 'string',
'NextMarker': 'string',
'Contents': [
TABLE OF CONTENTS
{
'Key': 'string',
Quickstart
'ETag': 'string',
(../../guide/sqs.html) 'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'GLACI
Code Examples 'Owner': {
(../../guide/examples.html) 'DisplayName': 'string',
'ID': 'string'
User Guides
}
},
'Name': 'string',
ACM (acm.html)
'Prefix': 'string',
ACMPCA (acm-pca.html) 'Delimiter': 'string',
'MaxKeys': 123,
AlexaForBusiness
(alexaforbusiness.html) 'CommonPrefixes': [
{
Amplify (amplify.html) 'Prefix': 'string'
APIGateway },
'EncodingType': 'url'
}
Api
api.html)
Response Structure
Boto 3 Docs 1.9.249
../../index.html) IsTruncated (boolean) --
A flag that indicates whether or not Amazon S3 returned all of the

TABLE OF CONTENTS results that satisfied the search criteria.
Marker (string) --
Quickstart
(../../guide/quickstart.html) NextMarker (string) --
A Sample Tutorial When response is truncated (the IsTruncated element value in the
(../../guide/sqs.html) response is true), you can use the key name in this field as marker in
the subsequent request to get next set of objects. Amazon S3 lists
Code Examples
objects in alphabetical order Note: This element is returned only if you
have delimiter request parameter specified. If response does not
User Guides include the NextMaker and it is truncated, you can use the value of the
(../../guide/index.html) last Key in the response as the marker in the subsequent request to get
the next set of object keys.
Contents (list) --
ACM (acm.html)
(dict) --
Key (string) --
AlexaForBusiness
(alexaforbusiness.html) LastModified (datetime) --
Amplify (amplify.html) ETag (string) --
APIGateway Size (integer) --

(apigateway.html) StorageClass (string) --
ApiGatewayManagement The class of storage used to store the object.
Api
Owner (dict) --
api.html) DisplayName (string) --
ID (string) --
Boto 3 Docs 1.9.249
Name (string) --
documentation (
Prefix (string) --
../../index.html)
Delimiter (string) --
TABLE OF CONTENTS MaxKeys (integer) --
CommonPrefixes (list) --
Quickstart
Prefix (string) --
A Sample Tutorial
Code Examples
response.
User Guides
(../../guide/index.html) list_objects_v2 (**kwargs)
Returns some or all (up to 1000) of the objects in a bucket. You can use the
request parameters as selection criteria to return a subset of the objects in a
ACM (acm.html) bucket. Note: ListObjectsV2 is the revised List Objects API and we recommend
you use this revised API for new application development.
AlexaForBusiness
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsV2)
Request Syntax
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.list_objects_v2(
../../index.html) Delimiter='string',
EncodingType='url',
MaxKeys=123,
TABLE OF CONTENTS
Prefix='string',
ContinuationToken='string',
Quickstart
FetchOwner=True|False,
StartAfter='string',
A Sample Tutorial RequestPayer='requester'
Code Examples
Parameters
User Guides Bucket (string) --
(../../guide/index.html) [REQUIRED]
Available Services (index.html) Name of the bucket to list.
ACM (acm.html) Delimiter (string) -- A delimiter is a character you use to group keys.
EncodingType (string) -- Encoding type used by Amazon S3 to encode
ACMPCA (acm-pca.html) object keys in the response.
AlexaForBusiness MaxKeys (integer) -- Sets the maximum number of keys returned in the
(alexaforbusiness.html) response. The response might contain fewer keys but will never contain
more.
APIGateway prefix.
(apigateway.html) ContinuationToken (string) -- ContinuationToken indicates Amazon S3
that the list is being continued on this bucket with a token.
ContinuationToken is obfuscated and is not a real key
Api
FetchOwner (boolean) -- The owner field is not present in listV2 by
default, if you want to return owner field with each key in the result then
api.html)
set the fetch owner field to true
Boto 3 Docs 1.9.249
StartAfter (string) -- StartAfter is where you want Amazon S3 to start
documentation ( listing from. Amazon S3 starts listing after this specified key. StartAfter
../../index.html) can be any key in the bucket
TABLE OF CONTENTS he will be charged for the list objects request in V2 style. Bucket owners
need not specify this parameter in their requests.
Quickstart Return type
(../../guide/quickstart.html) dict
A Sample Tutorial Returns
Response Syntax
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
../../index.html) 'Contents': [
{
'Key': 'string',
TABLE OF CONTENTS
'ETag': 'string',
Quickstart
'Size': 123,
'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'GLACI
A Sample Tutorial 'Owner': {
Code Examples 'ID': 'string'
},
User Guides
],
'Name': 'string',
Available Services (index.html) 'Prefix': 'string',
ACM (acm.html)
'MaxKeys': 123,
ACMPCA (acm-pca.html) 'CommonPrefixes': [
{
AlexaForBusiness
(alexaforbusiness.html) 'Prefix': 'string'
},
Amplify (amplify.html) ],
APIGateway 'EncodingType': 'url',
(apigateway.html) 'KeyCount': 123,
'ContinuationToken': 'string',
Api
'StartAfter': 'string'
api.html) }
Boto 3 Docs 1.9.249
TABLE OF CONTENTS
Quickstart results that satisfied the search criteria.
(../../guide/quickstart.html) Contents (list) --
A Sample Tutorial Metadata about each object returned.
(dict) --
Code Examples
User Guides
(../../guide/index.html) ETag (string) --
Available Services (index.html) Size (integer) --
ACM (acm.html) StorageClass (string) --
ACMPCA (acm-pca.html) The class of storage used to store the object.
AlexaForBusiness Owner (dict) --

(alexaforbusiness.html) DisplayName (string) --
Amplify (amplify.html) ID (string) --
Name (string) --
APIGateway
(apigateway.html) Name of the bucket to list.

Api Limits the response to keys that begin with the specified prefix.
api.html) Delimiter (string) --
A delimiter is a character you use to group keys.
Boto 3 Docs 1.9.249
documentation ( MaxKeys (integer) --
../../index.html) Sets the maximum number of keys returned in the response. The
response might contain fewer keys but will never contain more.
CommonPrefixes contains all (if there are any) keys between Prefix and
Quickstart
the next occurrence of the string specified by delimiter
(dict) --
A Sample Tutorial
Prefix (string) --
Code Examples
response.
User Guides KeyCount (integer) --
KeyCount is the number of keys returned with this request. KeyCount
Available Services (index.html) will always be less than equals to MaxKeys field. Say you ask for 50
ACM (acm.html) keys, your result will include less than equals 50 keys
ACMPCA (acm-pca.html) ContinuationToken (string) --
AlexaForBusiness ContinuationToken indicates Amazon S3 that the list is being continued

(alexaforbusiness.html) on this bucket with a token. ContinuationToken is obfuscated and is
not a real key
NextContinuationToken (string) --
APIGateway
(apigateway.html) NextContinuationToken is sent when isTruncated is true which means
there are more keys in the bucket that can be listed. The next list
ApiGatewayManagement requests to Amazon S3 can be continued with this
Api NextContinuationToken. NextContinuationToken is obfuscated and is
(apigatewaymanagement not a real key
api.html)
StartAfter (string) --
Boto 3 Docs 1.9.249
documentation ( StartAfter is where you want Amazon S3 to start listing from. Amazon
S3 starts listing after this specified key. StartAfter can be any key in the
../../index.html)
bucket
TABLE OF CONTENTS
list_parts (**kwargs)
Quickstart
Lists the parts that have been uploaded for a specific multipart upload.
A Sample Tutorial
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListParts)
Request Syntax
Code Examples
response = client.list_parts(
(../../guide/index.html) Key='string',
Available Services (index.html) MaxParts=123,
PartNumberMarker=123,
ACM (acm.html)
UploadId='string',
ACMPCA (acm-pca.html) RequestPayer='requester'
)
AlexaForBusiness

APIGateway
(apigateway.html)
MaxParts (integer) -- Sets the maximum number of parts to return.
ApiGatewayManagement PartNumberMarker (integer) -- Specifies the part after which listing
Api should begin. Only parts with higher part numbers will be listed.
(apigatewaymanagement UploadId (string) --
api.html) [REQUIRED]
Upload ID identifying the multipart upload whose parts are being listed.
Boto 3 Docs 1.9.249
../../index.html)
TABLE OF CONTENTS http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
Quickstart
Return type
dict
A Sample Tutorial
Code Examples Response Syntax

User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
'Bucket': 'string',
'Key': 'string',
TABLE OF CONTENTS
'PartNumberMarker': 123,
Quickstart
'NextPartNumberMarker': 123,
'MaxParts': 123,
A Sample Tutorial 'IsTruncated': True|False,
(../../guide/sqs.html) 'Parts': [
Code Examples {
(../../guide/examples.html) 'PartNumber': 123,
User Guides
'ETag': 'string',
'Size': 123
],
ACM (acm.html)
'Initiator': {
ACMPCA (acm-pca.html) 'ID': 'string',
AlexaForBusiness
'Owner': {
Amplify (amplify.html) 'DisplayName': 'string',
APIGateway 'ID': 'string'
Api
}
api.html)
Response Structure
Boto 3 Docs 1.9.249
../../index.html) AbortDate (datetime) --
Date when multipart upload will become eligible for abort operation by
TABLE OF CONTENTS lifecycle.
AbortRuleId (string) --
Quickstart
(../../guide/quickstart.html) Id of the lifecycle rule that makes a multipart upload eligible for abort
operation.
A Sample Tutorial
(../../guide/sqs.html) Bucket (string) --
Key (string) --
User Guides Object key for which the multipart upload was initiated.
Upload ID identifying the multipart upload whose parts are being
ACM (acm.html) listed.
ACMPCA (acm-pca.html) PartNumberMarker (integer) --
AlexaForBusiness Part number after which listing begins.
NextPartNumberMarker (integer) --
When a list is truncated, this element specifies the last part in the list,
APIGateway as well as the value to use for the part-number-marker request
(apigateway.html) parameter in a subsequent request.
ApiGatewayManagement MaxParts (integer) --
Api
Maximum number of parts that were allowed in the response.
api.html) IsTruncated (boolean) --
Indicates whether the returned list of parts is truncated.
Boto 3 Docs 1.9.249
documentation ( Parts (list) --
TABLE OF CONTENTS
Part number identifying the part. This is a positive integer between
1 and 10,000.
Quickstart
(../../guide/quickstart.html) LastModified (datetime) --
A Sample Tutorial Date and time at which the part was uploaded.
ETag (string) --
Code Examples
Entity tag returned when the part was uploaded.
Size (integer) --
User Guides
(../../guide/index.html) Size in bytes of the uploaded part data.
Initiator (dict) --
Identifies who initiated the multipart upload.
ACM (acm.html)
ID (string) --
If the principal is an AWS account, it provides the Canonical User ID. If
AlexaForBusiness
the principal is an IAM User, it provides a user ARN value.
APIGateway
(apigateway.html) Owner (dict) --
ApiGatewayManagement DisplayName (string) --

Api ID (string) --
(apigatewaymanagement StorageClass (string) --
api.html)
The class of storage used to store the object.
Boto 3 Docs 1.9.249
documentation ( RequestCharged (string) --
../../index.html) If present, indicates that the requester was successfully charged for the
request.
TABLE OF CONTENTS
put_bucket_accelerate_configuration (**kwargs)
Quickstart
(../../guide/quickstart.html) Sets the accelerate configuration of an existing bucket.
A Sample Tutorial See also: AWS API Documentation

(../../guide/sqs.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-
01/PutBucketAccelerateConfiguration)
Code Examples
(../../guide/examples.html) Request Syntax
User Guides
(../../guide/index.html) response = client.put_bucket_accelerate_configuration(
Bucket='string',
Available Services (index.html) AccelerateConfiguration={
ACM (acm.html) 'Status': 'Enabled'|'Suspended'
}
)
AlexaForBusiness
Parameters
Amplify (amplify.html) Bucket (string) --
APIGateway [REQUIRED]
(apigateway.html) Name of the bucket for which the accelerate configuration is set.
ApiGatewayManagement AccelerateConfiguration (dict) --
Api [REQUIRED]
api.html) Specifies the Accelerate Configuration you want to set for the bucket.
Status (string) --
Boto 3 Docs 1.9.249
Specifies the transfer acceleration status of the bucket.
documentation (
Returns
../../index.html)
None
TABLE OF CONTENTS
put_bucket_acl (**kwargs)
Quickstart
Sets the permissions on a bucket using access control lists (ACL).
A Sample Tutorial
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAcl)
Request Syntax
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.put_bucket_acl(
../../index.html) AccessControlPolicy={
'Grants': [
{
TABLE OF CONTENTS
'Grantee': {
Quickstart
'ID': 'string',
A Sample Tutorial 'Type': 'CanonicalUser'|'AmazonCustomerByEmail'|'G
Code Examples },
(../../guide/examples.html) 'Permission': 'FULL_CONTROL'|'WRITE'|'WRITE_ACP'|'READ
},
User Guides
],
'Owner': {
'ID': 'string'
ACM (acm.html)
}
Bucket='string',
AlexaForBusiness
(alexaforbusiness.html) GrantFullControl='string',
GrantRead='string',
Amplify (amplify.html) GrantReadACP='string',
APIGateway GrantWrite='string',
(apigateway.html) GrantWriteACP='string'
)
Api
ACL (string) -- The canned ACL to apply to the bucket.
Boto 3 Docs 1.9.249
AccessControlPolicy (dict) --
documentation ( Contains the elements that set the ACL permissions for an object per
../../index.html) grantee.
Grants (list) --
TABLE OF CONTENTS A list of grants.
(dict) --
Quickstart
Grantee (dict) --
A Sample Tutorial Screen name of the grantee.
Code Examples Email address of the grantee.
ID (string) --
User Guides The canonical user ID of the grantee.
Type (string) -- [REQUIRED]
Available Services (index.html) Type of grantee
ACM (acm.html) URI (string) --

Permission (string) --
AlexaForBusiness Specifies the permission given to the grantee.
Owner (dict) --
Amplify (amplify.html) Container for the bucket owner's display name and ID.
APIGateway DisplayName (string) --
(apigateway.html) ID (string) --
ApiGatewayManagement Bucket (string) -- [REQUIRED]
Api GrantFullControl (string) -- Allows grantee the read, write, read ACP, and
(apigatewaymanagement write ACP permissions on the bucket.
api.html) GrantRead (string) -- Allows grantee to list the objects in the bucket.
GrantReadACP (string) -- Allows grantee to read the bucket ACL.
Boto 3 Docs 1.9.249
GrantWrite (string) -- Allows grantee to create, overwrite, and delete any
documentation ( object in the bucket.
../../index.html) GrantWriteACP (string) -- Allows grantee to write the ACL for the
applicable bucket.
None
Quickstart
A Sample Tutorial put_bucket_analytics_configuration (**kwargs)

(../../guide/sqs.html) Sets an analytics configuration for the bucket (specified by the analytics
configuration ID).
Code Examples
(../../guide/examples.html) See also: AWS API Documentation
User Guides
01/PutBucketAnalyticsConfiguration)
Request Syntax
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.put_bucket_analytics_configuration(
../../index.html) Id='string',
AnalyticsConfiguration={
'Id': 'string',
TABLE OF CONTENTS
'Filter': {
'Prefix': 'string',
Quickstart
'Tag': {
'Key': 'string',
A Sample Tutorial 'Value': 'string'
Code Examples 'And': {
(../../guide/examples.html) 'Prefix': 'string',
'Tags': [
User Guides
{
'Key': 'string',
Available Services (index.html) 'Value': 'string'
},
ACM (acm.html)
]
},
AlexaForBusiness
(alexaforbusiness.html) 'StorageClassAnalysis': {
'DataExport': {
Amplify (amplify.html) 'OutputSchemaVersion': 'V_1',
APIGateway 'Destination': {
(apigateway.html) 'S3BucketDestination': {
'Format': 'CSV',
'BucketAccountId': 'string',
Api
'Bucket': 'string',
api.html) 'Prefix': 'string'
}
Boto 3 Docs 1.9.249
}
documentation ( }
../../index.html) }
}
TABLE OF CONTENTS )
Quickstart
Parameters
Bucket (string) --
A Sample Tutorial [REQUIRED]
The name of the bucket to which an analytics configuration is stored.
Code Examples
Id (string) --
[REQUIRED]
User Guides
The ID that identifies the analytics configuration.
AnalyticsConfiguration (dict) --
ACM (acm.html) The configuration and any analyses for the analytics filter.
ACMPCA (acm-pca.html) Id (string) -- [REQUIRED]
AlexaForBusiness The ID that identifies the analytics configuration.
(alexaforbusiness.html) Filter (dict) --
Amplify (amplify.html) The filter used to describe a set of objects for analyses. A filter must
have exactly one prefix, one tag, or one conjunction
APIGateway
(AnalyticsAndOperator). If no filter is provided, all objects will be
(apigateway.html)
considered in any analysis.
Prefix (string) --
Api
The prefix to use when evaluating an analytics filter.
api.html) Tag (dict) --
The tag to use when evaluating an analytics filter.
Boto 3 Docs 1.9.249
documentation ( Key (string) -- [REQUIRED]
Name of the tag.
../../index.html)
Value (string) -- [REQUIRED]
TABLE OF CONTENTS Value of the tag.
And (dict) --
Quickstart A conjunction (logical AND) of predicates, which is used in evaluating
(../../guide/quickstart.html) an analytics filter. The operator must have at least two predicates.
A Sample Tutorial Prefix (string) --
(../../guide/sqs.html) The prefix to use when evaluating an AND predicate: The prefix
that an object must have to be included in the metrics results.
Code Examples
(../../guide/examples.html) Tags (list) --
The list of tags to use when evaluating an AND predicate.
User Guides
Available Services (index.html) Name of the tag.
ACM (acm.html) Value (string) -- [REQUIRED]
ACMPCA (acm-pca.html) Value of the tag.
AlexaForBusiness StorageClassAnalysis (dict) -- [REQUIRED]

(alexaforbusiness.html) Contains data related to access patterns to be collected and made
available to analyze the tradeoffs between different storage classes.
DataExport (dict) --
APIGateway Specifies how data related to the storage class analysis for an
(apigateway.html) Amazon S3 bucket should be exported.
ApiGatewayManagement OutputSchemaVersion (string) -- [REQUIRED]
Api The version of the output schema to use when exporting data.
(apigatewaymanagement Must be V_1 .
api.html)
Destination (dict) -- [REQUIRED]
Boto 3 Docs 1.9.249
documentation (
S3BucketDestination (dict) -- [REQUIRED]
../../index.html)
A destination signifying output to an S3 bucket.
TABLE OF CONTENTS Format (string) -- [REQUIRED]

Specifies the file format used when exporting data to Amazon
S3.
Quickstart
(../../guide/quickstart.html) BucketAccountId (string) --
The account ID that owns the destination bucket. If no account
A Sample Tutorial
ID is provided, the owner will not be validated prior to
exporting data.
Code Examples
The Amazon Resource Name (ARN) of the bucket to which data
User Guides is exported.
Prefix (string) --
Available Services (index.html) The prefix to use when exporting data. The prefix is
prepended to all results.
ACM (acm.html)
Returns
None
AlexaForBusiness
put_bucket_cors (**kwargs)
Sets the CORS configuration for a bucket.
APIGateway
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketCors)
Api Request Syntax
api.html)
Boto 3 Docs 1.9.249 response = client.put_bucket_cors(
../../index.html) CORSConfiguration={
'CORSRules': [
{
TABLE OF CONTENTS
'AllowedHeaders': [
'string',
Quickstart
],
'AllowedMethods': [
A Sample Tutorial 'string',
(../../guide/sqs.html) ],
Code Examples 'AllowedOrigins': [
(../../guide/examples.html) 'string',
],
User Guides
'ExposeHeaders': [
'string',
'MaxAgeSeconds': 123
ACM (acm.html)
},
ACMPCA (acm-pca.html) ]
},
AlexaForBusiness
)
APIGateway
Parameters
(apigateway.html)
ApiGatewayManagement CORSConfiguration (dict) --
Api [REQUIRED]
CORSRules (list) -- [REQUIRED]
api.html)
A set of allowed origins and methods.
Boto 3 Docs 1.9.249
Specifies a cross-origin access rule for an Amazon S3 bucket.
../../index.html)
AllowedHeaders (list) --
TABLE OF CONTENTS Headers that are specified in the Access-Control-Request-Headers
header. These headers are allowed in a preflight OPTIONS request.
Quickstart
In response to any preflight OPTIONS request, Amazon S3 returns
any requested headers that are allowed.
A Sample Tutorial
(string) --
AllowedMethods (list) -- [REQUIRED]
Code Examples are GET , PUT , HEAD , POST , and DELETE .
(string) --
User Guides AllowedOrigins (list) -- [REQUIRED]
(../../guide/index.html) One or more origins you want customers to be able to access the
bucket from.
(string) --
ACM (acm.html)
ACMPCA (acm-pca.html) One or more headers in the response that you want customers to
be able to access from their applications (for example, from a
AlexaForBusiness
JavaScript XMLHttpRequest object).
(string) --
APIGateway The time in seconds that your browser is to cache the preflight
(apigateway.html) response for the specified resource.
Api None
api.html)
Boto 3 Docs 1.9.249 put_bucket_encryption (**kwargs)
Creates a new server-side encryption configuration (or replaces an existing one,
documentation (
if present).
../../index.html)
TABLE OF CONTENTS
01/PutBucketEncryption)
Quickstart Request Syntax

A Sample Tutorial response = client.put_bucket_encryption(

(../../guide/sqs.html) Bucket='string',
ContentMD5='string',
Code Examples
(../../guide/examples.html) ServerSideEncryptionConfiguration={
'Rules': [
User Guides {
(../../guide/index.html) 'ApplyServerSideEncryptionByDefault': {
'SSEAlgorithm': 'AES256'|'aws:kms',
'KMSMasterKeyID': 'string'
ACM (acm.html) }
]
AlexaForBusiness
}
)
(apigateway.html)
Bucket (string) --
Api
Specifies default encryption for a bucket using server-side encryption
with Amazon S3-managed keys (SSE-S3) or AWS KMS-managed keys (SSE-
api.html)
KMS). For information about the Amazon S3 default encryption feature,
see Amazon S3 Default Bucket Encryption
Boto 3 Docs 1.9.249
(https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-
documentation ( encryption.html) in the Amazon Simple Storage Service Developer Guide .
../../index.html)
ContentMD5 (string) -- The base64-encoded 128-bit MD5 digest of the
server-side encryption configuration. This parameter is auto-populated
TABLE OF CONTENTS when using the command from the CLI.
ServerSideEncryptionConfiguration (dict) --
Rules (list) -- [REQUIRED]
A Sample Tutorial Container for information about a particular server-side encryption
(../../guide/sqs.html) configuration rule.
(../../guide/examples.html) Specifies the default server-side encryption configuration.
User Guides ApplyServerSideEncryptionByDefault (dict) --

(../../guide/index.html) Specifies the default server-side encryption to apply to new objects
in the bucket. If a PUT Object request doesn't specify any server-
Available Services (index.html) side encryption, this default encryption will be applied.
ACM (acm.html) SSEAlgorithm (string) -- [REQUIRED]
ACMPCA (acm-pca.html) Server-side encryption algorithm to use for the default
encryption.
AlexaForBusiness
(alexaforbusiness.html) KMSMasterKeyID (string) --
KMS master key ID to use for the default encryption. This
parameter is allowed if and only if SSEAlgorithm is set to
APIGateway aws:kms .
(apigateway.html)
Returns
ApiGatewayManagement None
Api
api.html) put_bucket_inventory_configuration (**kwargs)
Adds an inventory configuration (identified by the inventory ID) from the
Boto 3 Docs 1.9.249
bucket.
documentation (
../../index.html)
01/PutBucketInventoryConfiguration)
TABLE OF CONTENTS
Request Syntax
Quickstart
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.put_bucket_inventory_configuration(
InventoryConfiguration={
'Destination': {
TABLE OF CONTENTS
Quickstart
'Bucket': 'string',
(../../guide/sqs.html) 'Encryption': {
Code Examples 'SSES3': {}
(../../guide/examples.html) ,
'SSEKMS': {
User Guides
'KeyId': 'string'
}
}
ACM (acm.html)
},
ACMPCA (acm-pca.html) 'IsEnabled': True|False,
'Filter': {
AlexaForBusiness
},
Amplify (amplify.html) 'Id': 'string',
APIGateway 'IncludedObjectVersions': 'All'|'Current',
(apigateway.html) 'OptionalFields': [
'Size'|'LastModifiedDate'|'StorageClass'|'ETag'|'IsMultipa
],
Api
'Schedule': {
api.html) 'Frequency': 'Daily'|'Weekly'
}
Boto 3 Docs 1.9.249
}
documentation ( )
../../index.html)

Bucket (string) --
The name of the bucket where the inventory configuration will be stored.
A Sample Tutorial
(../../guide/sqs.html) Id (string) --
[REQUIRED]
Code Examples
(../../guide/examples.html) The ID used to identify the inventory configuration.
InventoryConfiguration (dict) --
User Guides
[REQUIRED]
Specifies the inventory configuration.
ACM (acm.html)
Contains information about where to publish the inventory results.
S3BucketDestination (dict) -- [REQUIRED]
AlexaForBusiness Contains the bucket name, file format, bucket owner (optional), and
(alexaforbusiness.html) prefix (optional) where inventory results are published.
Amplify (amplify.html) AccountId (string) --

The ID of the account that owns the destination bucket.
APIGateway
The Amazon resource name (ARN) of the bucket where inventory
results will be published.
Api
(apigatewaymanagement Format (string) -- [REQUIRED]
api.html) Specifies the output format of the inventory results.
Prefix (string) --
Boto 3 Docs 1.9.249
The prefix that is prepended to all inventory results.
documentation (
Encryption (dict) --
../../index.html)
Contains the type of server-side encryption used to encrypt the
inventory results.
TABLE OF CONTENTS
SSES3 (dict) --
Specifies the use of SSE-S3 to encrypt delivered Inventory
Quickstart
reports.
SSEKMS (dict) --
A Sample Tutorial
Specifies the use of SSE-KMS to encrypt delivered Inventory
reports.
Code Examples
KeyId (string) -- [REQUIRED]
Specifies the ID of the AWS Key Management Service (KMS)
User Guides master encryption key to use for encrypting Inventory reports.
IsEnabled (boolean) -- [REQUIRED]
Available Services (index.html) Specifies whether the inventory is enabled or disabled. If set to True ,
an inventory list is generated. If set to False , no inventory list is
ACM (acm.html)
generated.
Filter (dict) --
AlexaForBusiness Specifies an inventory filter. The inventory only includes objects that
(alexaforbusiness.html) meet the filter's criteria.
Amplify (amplify.html) Prefix (string) -- [REQUIRED]

The prefix that an object must have to be included in the inventory
APIGateway
results.
(apigateway.html)
Id (string) -- [REQUIRED]
The ID used to identify the inventory configuration.
Api
(apigatewaymanagement IncludedObjectVersions (string) -- [REQUIRED]
api.html)
Object versions to include in the inventory list. If set to All , the list
Boto 3 Docs 1.9.249
includes all the object versions, which adds the version-related fields
documentation ( VersionId , IsLatest , and DeleteMarker to the list. If set to Current ,
../../index.html) the list does not contain these version-related fields.
TABLE OF CONTENTS
Contains the optional fields that are included in the inventory results.
Quickstart (string) --
(../../guide/quickstart.html) Schedule (dict) -- [REQUIRED]
Specifies the schedule for generating inventory results.
A Sample Tutorial
(../../guide/sqs.html) Frequency (string) -- [REQUIRED]
Specifies how frequently inventory results are produced.
Code Examples
None
User Guides
put_bucket_lifecycle (**kwargs)
No longer used, see the PutBucketLifecycleConfiguration operation.
ACM (acm.html)
Danger
AlexaForBusiness
operation should not be used going forward and is only kept for the
Amplify (amplify.html) purpose of backwards compatiblity.
APIGateway
ApiGatewayManagement (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketLifecycle)
Api Request Syntax
api.html)
Boto 3 Docs 1.9.249 response = client.put_bucket_lifecycle(
../../index.html) LifecycleConfiguration={
'Rules': [
{
TABLE OF CONTENTS
'Expiration': {
Quickstart
'Days': 123,
A Sample Tutorial },
(../../guide/examples.html) 'Status': 'Enabled'|'Disabled',
'Transition': {
User Guides
'Days': 123,
Available Services (index.html) 'StorageClass': 'GLACIER'|'STANDARD_IA'|'ONEZONE_I
},
ACM (acm.html)
'NoncurrentVersionTransition': {
ACMPCA (acm-pca.html) 'NoncurrentDays': 123,
AlexaForBusiness
Amplify (amplify.html) 'NoncurrentDays': 123
APIGateway },
(apigateway.html) 'AbortIncompleteMultipartUpload': {
'DaysAfterInitiation': 123
}
Api
},
api.html) ]
}
Boto 3 Docs 1.9.249
)
documentation (
../../index.html)
Parameters
TABLE OF CONTENTS
LifecycleConfiguration (dict) --
Quickstart Rules (list) -- [REQUIRED]
A Sample Tutorial Specifies lifecycle rules for an Amazon S3 bucket. For more
(../../guide/sqs.html) information, see PUT Bucket lifecycle
Code Examples in the Amazon Simple Storage Service API Reference .
User Guides Date (datetime) --
(../../guide/index.html) Indicates at what date the object is to be moved or deleted.
Should be in GMT ISO 8601 Format.
Days (integer) --
ACM (acm.html)
ACMPCA (acm-pca.html) the rule. The value must be a non-zero positive integer.
AlexaForBusiness ExpiredObjectDeleteMarker (boolean) --
(alexaforbusiness.html) Indicates whether Amazon S3 will remove a delete marker with
no noncurrent versions. If set to true, the delete marker will be
APIGateway specified with Days or Date in a Lifecycle Expiration Policy.
(apigateway.html)
ID (string) --
ApiGatewayManagement Unique identifier for the rule. The value can't be longer than 255
Api characters.
Prefix (string) -- [REQUIRED]
api.html)
Object key prefix that identifies one or more objects to which this
Boto 3 Docs 1.9.249
rule applies.
documentation (
Status (string) -- [REQUIRED]
../../index.html)
If Enabled , the rule is currently being applied. If Disabled , the rule
is not currently being applied.
TABLE OF CONTENTS
Date (datetime) --
Quickstart
Indicates when objects are transitioned to the specified storage
class. The date value must be in ISO 8601 format. The time is
A Sample Tutorial always midnight UTC.
Days (integer) --
Code Examples Indicates the number of days after creation when objects are
(../../guide/examples.html) transitioned to the specified storage class. The value must be a
positive integer.
User Guides
(../../guide/index.html) StorageClass (string) --
The storage class to which you want the object to transition.
NoncurrentVersionTransition (dict) --
ACM (acm.html)
ACMPCA (acm-pca.html) Specifies the number of days an object is noncurrent before
AlexaForBusiness
Amplify (amplify.html) (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-
control.html) in the Amazon Simple Storage Service Developer
APIGateway
Guide .
(apigateway.html)
Api
(apigatewaymanagement NoncurrentVersionExpiration (dict) --
api.html) NoncurrentDays (integer) --
Boto 3 Docs 1.9.249
documentation ( about the noncurrent days calculations, see How Amazon S3
../../index.html) Calculates When an Object Became Noncurrent
TABLE OF CONTENTS lifecycle-rules.html#non-current-days-calculations) in the
Quickstart AbortIncompleteMultipartUpload (dict) --
(../../guide/quickstart.html) DaysAfterInitiation (integer) --
A Sample Tutorial Specifies the number of days after which Amazon S3 aborts an
(../../guide/sqs.html) incomplete multipart upload.

(../../guide/examples.html) None
User Guides
(../../guide/index.html) put_bucket_lifecycle_configuration (**kwargs)
Available Services (index.html) Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it
replaces it.
ACM (acm.html)
ACMPCA (acm-pca.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-
AlexaForBusiness 01/PutBucketLifecycleConfiguration)
(alexaforbusiness.html) Request Syntax
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.put_bucket_lifecycle_configuration(
../../index.html) LifecycleConfiguration={
'Rules': [
{
TABLE OF CONTENTS
'Expiration': {
Quickstart
'Days': 123,
(../../guide/examples.html) 'Filter': {
'Prefix': 'string',
User Guides
'Tag': {
'Key': 'string',
},
ACM (acm.html)
'And': {
ACMPCA (acm-pca.html) 'Prefix': 'string',
'Tags': [
AlexaForBusiness
(alexaforbusiness.html) {
'Key': 'string',
Amplify (amplify.html) 'Value': 'string'
APIGateway },
(apigateway.html) ]
}
},
Api
api.html) 'Transitions': [
{
Boto 3 Docs 1.9.249
documentation ( 'Days': 123,
../../index.html) 'StorageClass': 'GLACIER'|'STANDARD_IA'|'ONEZO
},
TABLE OF CONTENTS ],
'NoncurrentVersionTransitions': [
Quickstart {
(../../guide/quickstart.html) 'NoncurrentDays': 123,
'StorageClass': 'GLACIER'|'STANDARD_IA'|'ONEZO
A Sample Tutorial
},
],
Code Examples 'NoncurrentVersionExpiration': {
(../../guide/examples.html) 'NoncurrentDays': 123
User Guides },
(../../guide/index.html) 'AbortIncompleteMultipartUpload': {
'DaysAfterInitiation': 123
ACM (acm.html) },
]
}
AlexaForBusiness )
Parameters
APIGateway
ApiGatewayManagement Rules (list) -- [REQUIRED]
Api A lifecycle rule for individual objects in an Amazon S3 bucket.
api.html) (dict) --
Boto 3 Docs 1.9.249
Date (datetime) --
documentation ( Indicates at what date the object is to be moved or deleted.
../../index.html) Should be in GMT ISO 8601 Format.
Days (integer) --
TABLE OF CONTENTS Indicates the lifetime, in days, of the objects that are subject to
Quickstart
Indicates whether Amazon S3 will remove a delete marker with
A Sample Tutorial no noncurrent versions. If set to true, the delete marker will be
(../../guide/sqs.html) expired; if set to false the policy takes no action. This cannot be
Code Examples specified with Days or Date in a Lifecycle Expiration Policy.
(../../guide/examples.html) ID (string) --
Unique identifier for the rule. The value cannot be longer than 255
User Guides
characters.
Prefix (string) --
Available Services (index.html) Prefix identifying one or more objects to which the rule applies.
ACM (acm.html) This is No longer used; use Filter instead.
ACMPCA (acm-pca.html) Filter (dict) --

Prefix (string) --
AlexaForBusiness
Tag (dict) --
This tag must exist in the object's tag set in order for the rule to
APIGateway apply.
(apigateway.html)
ApiGatewayManagement Name of the tag.
Api
Value of the tag.
api.html)
And (dict) --
Boto 3 Docs 1.9.249
Prefix (string) --
documentation ( Tags (list) --
../../index.html) All of these tags must exist in the object's tag set in order for
the rule to apply.
TABLE OF CONTENTS (dict) --
Quickstart Name of the tag.
A Sample Tutorial Value of the tag.
Code Examples If 'Enabled', the rule is currently being applied. If 'Disabled', the rule
(../../guide/examples.html) is not currently being applied.
User Guides Transitions (list) --

Specifies when an object transitions to a specified storage class.
Date (datetime) --
ACM (acm.html) Indicates when objects are transitioned to the specified
ACMPCA (acm-pca.html) storage class. The date value must be in ISO 8601 format. The
time is always midnight UTC.
AlexaForBusiness
(alexaforbusiness.html) Days (integer) --
transitioned to the specified storage class. The value must be a
APIGateway positive integer.
(apigateway.html)
ApiGatewayManagement The storage class to which you want the object to transition.
Api
NoncurrentVersionTransitions (list) --
(dict) --
api.html)
Boto 3 Docs 1.9.249
documentation ( INTELLIGENT_TIERING , GLACIER , or DEEP_ARCHIVE storage class.
../../index.html) If your bucket is versioning-enabled (or versioning is suspended),
you can set this action to request that Amazon S3 transition
TABLE OF CONTENTS noncurrent object versions to the STANDARD_IA , ONEZONE_IA ,
INTELLIGENT_TIERING , GLACIER , or DEEP_ARCHIVE storage class
Quickstart at a specific period in the object's lifetime.
(../../guide/quickstart.html) NoncurrentDays (integer) --
A Sample Tutorial Specifies the number of days an object is noncurrent before
(../../guide/sqs.html) Amazon S3 can perform the associated action. For information
Code Examples
(https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-
User Guides access-control.html) in the Amazon Simple Storage Service
(../../guide/index.html) Developer Guide .
ACM (acm.html)
ACMPCA (acm-pca.html) NoncurrentDays (integer) --
AlexaForBusiness Specifies the number of days an object is noncurrent before
(alexaforbusiness.html) Amazon S3 can perform the associated action. For information
Amplify (amplify.html) Calculates When an Object Became Noncurrent
APIGateway (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-
(apigateway.html) lifecycle-rules.html#non-current-days-calculations) in the
Api AbortIncompleteMultipartUpload (dict) --
(apigatewaymanagement DaysAfterInitiation (integer) --
api.html)
Specifies the number of days after which Amazon S3 aborts an
Boto 3 Docs 1.9.249
documentation (
Returns
../../index.html)
None
TABLE OF CONTENTS
put_bucket_logging (**kwargs)
Quickstart
Set the logging parameters for a bucket and to specify permissions for who can
view and modify the logging parameters. To set the logging status of a bucket,
A Sample Tutorial you must be the bucket owner.
Code Examples (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketLogging)
Request Syntax
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.put_bucket_logging(
../../index.html) BucketLoggingStatus={
'LoggingEnabled': {
'TargetBucket': 'string',
TABLE OF CONTENTS
'TargetGrants': [
{
Quickstart
'Grantee': {
A Sample Tutorial 'EmailAddress': 'string',
Code Examples 'Type': 'CanonicalUser'|'AmazonCustomerByEmail
(../../guide/examples.html) 'URI': 'string'
},
User Guides
'Permission': 'FULL_CONTROL'|'READ'|'WRITE'
},
ACM (acm.html)
}
AlexaForBusiness
ApiGatewayManagement BucketLoggingStatus (dict) --
Api [REQUIRED]
(apigatewaymanagement LoggingEnabled (dict) --
api.html) TargetBucket (string) -- [REQUIRED]
Boto 3 Docs 1.9.249
documentation ( own, including the same bucket that is being logged. You can also
../../index.html) configure multiple buckets to deliver their logs to the same target
TABLE OF CONTENTS each source bucket so that the delivered log files can be
distinguished by key.
Quickstart TargetGrants (list) --
A Sample Tutorial Grantee (dict) --
(../../guide/sqs.html) DisplayName (string) --
Code Examples
(../../guide/examples.html) EmailAddress (string) --
User Guides
ID (string) --
Available Services (index.html) Type (string) -- [REQUIRED]
ACM (acm.html) Type of grantee
ACMPCA (acm-pca.html) URI (string) --

AlexaForBusiness
(alexaforbusiness.html) Permission (string) --
Logging permissions assigned to the Grantee for the bucket.
TargetPrefix (string) -- [REQUIRED]
APIGateway
A prefix for all log object keys. If you store log files from multiple
(apigateway.html)
Amazon S3 buckets in a single bucket, you can use a prefix to
ApiGatewayManagement distinguish which log files came from which bucket.
Api
Returns
None
api.html)
Boto 3 Docs 1.9.249
put_bucket_metrics_configuration (**kwargs)
documentation (
Sets a metrics configuration (specified by the metrics configuration ID) for the
../../index.html)
bucket.
TABLE OF CONTENTS See also: AWS API Documentation

01/PutBucketMetricsConfiguration)
Quickstart
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.put_bucket_metrics_configuration(
MetricsConfiguration={
'Id': 'string',
TABLE OF CONTENTS
'Filter': {
'Prefix': 'string',
Quickstart
'Tag': {
'Key': 'string',
A Sample Tutorial 'Value': 'string'
Code Examples 'And': {
'Tags': [
User Guides
{
'Key': 'string',
},
ACM (acm.html)
]
}
AlexaForBusiness
)
APIGateway
Parameters
(apigateway.html)
Bucket (string) --
Api
The name of the bucket for which the metrics configuration is set.
api.html) Id (string) --
[REQUIRED]
Boto 3 Docs 1.9.249
documentation ( The ID used to identify the metrics configuration.
../../index.html) MetricsConfiguration (dict) --

[REQUIRED]
TABLE OF CONTENTS Specifies the metrics configuration.
Id (string) -- [REQUIRED]
Quickstart
The ID used to identify the metrics configuration.
Filter (dict) --
A Sample Tutorial
Specifies a metrics configuration filter. The metrics configuration will
only include objects that meet the filter's criteria. A filter must be a
Code Examples prefix, a tag, or a conjunction (MetricsAndOperator).
Prefix (string) --
User Guides The prefix used when evaluating a metrics filter.
(../../guide/index.html) Tag (dict) --
Available Services (index.html) The tag used when evaluating a metrics filter.
ACM (acm.html) Key (string) -- [REQUIRED]

Name of the tag.
AlexaForBusiness Value of the tag.
And (dict) --
Amplify (amplify.html) A conjunction (logical AND) of predicates, which is used in evaluating
APIGateway a metrics filter. The operator must have at least two predicates, and
(apigateway.html) an object must match all of the predicates in order for the filter to
apply.
Api Prefix (string) --
(apigatewaymanagement The prefix used when evaluating an AND predicate.
api.html) Tags (list) --
The list of tags used when evaluating an AND predicate.
Boto 3 Docs 1.9.249
../../index.html)
Name of the tag.
TABLE OF CONTENTS Value (string) -- [REQUIRED]

Value of the tag.
Quickstart Returns
(../../guide/quickstart.html) None
A Sample Tutorial
put_bucket_notification (**kwargs)
Code Examples
No longer used, see the PutBucketNotificationConfiguration operation.
User Guides
(../../guide/index.html) Danger
Available Services (index.html) operation should not be used going forward and is only kept for the
ACM (acm.html) purpose of backwards compatiblity.

(alexaforbusiness.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-
01/PutBucketNotification)
Request Syntax
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.put_bucket_notification(
../../index.html) NotificationConfiguration={
'TopicConfiguration': {
'Id': 'string',
TABLE OF CONTENTS
'Events': [
Quickstart
],
A Sample Tutorial 'Topic': 'string'
Code Examples 'QueueConfiguration': {
(../../guide/examples.html) 'Id': 'string',
User Guides
'Events': [
'Queue': 'string'
ACM (acm.html)
},
ACMPCA (acm-pca.html) 'CloudFunctionConfiguration': {
'Id': 'string',
AlexaForBusiness
(alexaforbusiness.html) 'Event': 's3:ReducedRedundancyLostObject'|'s3:ObjectCreate
'Events': [
Amplify (amplify.html) 's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|
APIGateway ],
(apigateway.html) 'CloudFunction': 'string',
'InvocationRole': 'string'
}
Api
}
api.html) )
Boto 3 Docs 1.9.249
../../index.html) Bucket (string) -- [REQUIRED]
NotificationConfiguration (dict) --
TABLE OF CONTENTS [REQUIRED]
TopicConfiguration (dict) --
Quickstart Id (string) --
(../../guide/quickstart.html) An optional unique identifier for configurations in a notification
A Sample Tutorial
(../../guide/sqs.html) Events (list) --
(string) --
Code Examples
Event (string) --
User Guides
Bucket event for which to send notifications.
Topic (string) --
Available Services (index.html) Amazon SNS topic to which Amazon S3 will publish a message to
ACM (acm.html) report the specified events for the bucket.
ACMPCA (acm-pca.html) QueueConfiguration (dict) --

Id (string) --
AlexaForBusiness An optional unique identifier for configurations in a notification
(alexaforbusiness.html) configuration. If you don't provide one, Amazon S3 will assign an ID.
Amplify (amplify.html) Event (string) --
APIGateway The bucket event for which to send notifications.
(apigateway.html) Events (list) --
Api The bucket event for which to send notifications.
(apigatewaymanagement Queue (string) --
api.html) CloudFunctionConfiguration (dict) --
Id (string) --
Boto 3 Docs 1.9.249
documentation ( configuration. If you don't provide one, Amazon S3 will assign an ID.
../../index.html)
Event (string) --
TABLE OF CONTENTS
Events (list) --
(string) --
Quickstart
CloudFunction (string) --
A Sample Tutorial
InvocationRole (string) --
Returns
Code Examples
User Guides
(../../guide/index.html) put_bucket_notification_configuration (**kwargs)
Available Services (index.html) Enables notifications of specified events for a bucket.
ACM (acm.html) See also: AWS API Documentation

ACMPCA (acm-pca.html) 01/PutBucketNotificationConfiguration)
AlexaForBusiness Request Syntax
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.put_bucket_notification_configuration(
../../index.html) NotificationConfiguration={
'TopicConfigurations': [
{
TABLE OF CONTENTS
'Id': 'string',
Quickstart
'Events': [
A Sample Tutorial ],
(../../guide/sqs.html) 'Filter': {
Code Examples 'Key': {
(../../guide/examples.html) 'FilterRules': [
{
User Guides
'Value': 'string'
]
ACM (acm.html)
}
},
AlexaForBusiness
(alexaforbusiness.html) ],
'QueueConfigurations': [
APIGateway 'Id': 'string',
(apigateway.html) 'QueueArn': 'string',
'Events': [
Api
],
api.html) 'Filter': {
'Key': {
Boto 3 Docs 1.9.249
'FilterRules': [
documentation ( {
../../index.html) 'Name': 'prefix'|'suffix',
'Value': 'string'
TABLE OF CONTENTS },
]
Quickstart }
},
A Sample Tutorial
],
Code Examples {
(../../guide/examples.html) 'Id': 'string',
User Guides 'LambdaFunctionArn': 'string',
(../../guide/index.html) 'Events': [
ACM (acm.html) 'Filter': {
'Key': {
'FilterRules': [
AlexaForBusiness {
(alexaforbusiness.html) 'Name': 'prefix'|'suffix',
Amplify (amplify.html) 'Value': 'string'

},
APIGateway ]
(apigateway.html)
}
Api },
(apigatewaymanagement ]
api.html)
}
Boto 3 Docs 1.9.249
)
documentation (
../../index.html)
Parameters
TABLE OF CONTENTS
NotificationConfiguration (dict) --
TopicConfigurations (list) --
A Sample Tutorial The topic to which notifications are sent and the events for which
(../../guide/sqs.html) notifications are generated.
(../../guide/examples.html) A container for specifying the configuration for publication of
messages to an Amazon Simple Notification Service (Amazon SNS)
User Guides
topic when Amazon S3 detects specified events.
Id (string) --
ACM (acm.html) configuration. If you don't provide one, Amazon S3 will assign an
ID.
TopicArn (string) -- [REQUIRED]
AlexaForBusiness
Amplify (amplify.html) the specified type.
APIGateway Events (list) -- [REQUIRED]
(apigateway.html) The Amazon S3 bucket event about which to send notifications. For
Api
api.html) (string) --
Boto 3 Docs 1.9.249
documentation ( Filter (dict) --
Key (dict) --
../../index.html)
(dict) --
TABLE OF CONTENTS Specifies the Amazon S3 object key name to filter on and
Quickstart
Name (string) --
The object key name prefix or suffix identifying one or
A Sample Tutorial more objects to which the filtering rule applies. The
(../../guide/sqs.html) maximum length is 1,024 characters. Overlapping prefixes
Code Examples and suffixes are not supported. For more information, see
(../../guide/examples.html) Configuring Event Notifications
User Guides in the Amazon Simple Storage Service Developer Guide .
Value (string) --
Available Services (index.html) The value that the filter searches for in object key names.
ACM (acm.html) QueueConfigurations (list) --

the events for which to publish messages.
AlexaForBusiness
(dict) --
Amplify (amplify.html) Simple Queue Service (Amazon SQS) queue when Amazon S3 detects
specified events.
APIGateway
(apigateway.html) Id (string) --
Api
ID.
api.html) QueueArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon SQS queue to
Boto 3 Docs 1.9.249
documentation ( the specified type.
../../index.html)
Events (list) -- [REQUIRED]
(string) --
TABLE OF CONTENTS The bucket event for which to send notifications.
Filter (dict) --
Quickstart
Key (dict) --
A Sample Tutorial (dict) --
(../../guide/sqs.html) Specifies the Amazon S3 object key name to filter on and
Code Examples whether to filter on the suffix or prefix of the key name.
(../../guide/examples.html) Name (string) --
User Guides
maximum length is 1,024 characters. Overlapping prefixes
Available Services (index.html) and suffixes are not supported. For more information, see
Configuring Event Notifications
ACM (acm.html)
ACMPCA (acm-pca.html) in the Amazon Simple Storage Service Developer Guide .
AlexaForBusiness Value (string) --

(alexaforbusiness.html) The value that the filter searches for in object key names.
Amplify (amplify.html) LambdaFunctionConfigurations (list) --

Describes the AWS Lambda functions to invoke and the events for
APIGateway
which to invoke them.
(apigateway.html)
(dict) --
Api
notifications.
api.html) Id (string) --
Boto 3 Docs 1.9.249
documentation ( ID.
../../index.html)
LambdaFunctionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the AWS Lambda function
TABLE OF CONTENTS that Amazon S3 invokes when the specified event type occurs.

Quickstart
function. For more information, see Supported Event Types
A Sample Tutorial (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.h
(../../guide/sqs.html) in the Amazon Simple Storage Service Developer Guide .
Code Examples (string) --
(../../guide/examples.html) The bucket event for which to send notifications.
User Guides Filter (dict) --

(../../guide/index.html) Key (dict) --
ACM (acm.html) Specifies the Amazon S3 object key name to filter on and
Name (string) --
AlexaForBusiness
Amplify (amplify.html) maximum length is 1,024 characters. Overlapping prefixes
and suffixes are not supported. For more information, see
APIGateway
Configuring Event Notifications
(apigateway.html)
ApiGatewayManagement in the Amazon Simple Storage Service Developer Guide .
Api
Value (string) --
api.html)
Returns
Boto 3 Docs 1.9.249
None
documentation (
../../index.html)
put_bucket_policy (**kwargs)
TABLE OF CONTENTS Applies an Amazon S3 bucket policy to an Amazon S3 bucket.
Quickstart
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketPolicy)
Request Syntax
A Sample Tutorial
response = client.put_bucket_policy(
Code Examples
Bucket='string',
ConfirmRemoveSelfBucketAccess=True|False,
User Guides Policy='string'

Parameters
ACM (acm.html)
ACMPCA (acm-pca.html) ConfirmRemoveSelfBucketAccess (boolean) -- Set this parameter to
AlexaForBusiness true to confirm that you want to remove your permissions to change this
(alexaforbusiness.html) bucket policy in the future.
Policy (string) --
[REQUIRED]
APIGateway
The bucket policy as a JSON document.
(apigateway.html)
Returns
None
Api
api.html)
Boto 3 Docs 1.9.249 put_bucket_replication (**kwargs)
Creates a replication configuration or replaces an existing one. For more
documentation (
information, see Cross-Region Replication (CRR)
../../index.html) (https://docs.aws.amazon.com/AmazonS3/latest/dev/crr.html) in the Amazon S3
Developer Guide .
TABLE OF CONTENTS
Quickstart
01/PutBucketReplication)
Request Syntax
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.put_bucket_replication(
../../index.html) ReplicationConfiguration={
'Role': 'string',
'Rules': [
TABLE OF CONTENTS
{
'ID': 'string',
Quickstart
'Priority': 123,
'Prefix': 'string',
A Sample Tutorial 'Filter': {
Code Examples 'Tag': {
'Value': 'string'
User Guides
},
'And': {
'Tags': [
ACM (acm.html)
{
ACMPCA (acm-pca.html) 'Key': 'string',
'Value': 'string'
AlexaForBusiness
]
APIGateway },
(apigateway.html) 'Status': 'Enabled'|'Disabled',
'SourceSelectionCriteria': {
'SseKmsEncryptedObjects': {
Api
'Status': 'Enabled'|'Disabled'
api.html) }
},
Boto 3 Docs 1.9.249
'Destination': {
../../index.html) 'Account': 'string',
'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'S
TABLE OF CONTENTS 'AccessControlTranslation': {
'Owner': 'Destination'
Quickstart },
(../../guide/quickstart.html) 'EncryptionConfiguration': {
'ReplicaKmsKeyID': 'string'
A Sample Tutorial
}
},
Code Examples 'DeleteMarkerReplication': {
(../../guide/examples.html) 'Status': 'Enabled'|'Disabled'
User Guides }
(../../guide/index.html) },
]
ACM (acm.html) Token='string'
)
AlexaForBusiness
Parameters
ReplicationConfiguration (dict) --
APIGateway
[REQUIRED]
(apigateway.html)
Role (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the AWS Identity and Access
Api
Management (IAM) role that Amazon S3 assumes when replicating
objects. For more information, see How to Set Up Cross-Region
api.html)
Replication (https://docs.aws.amazon.com/AmazonS3/latest/dev/crr-
Boto 3 Docs 1.9.249
how-setup.html) in the Amazon Simple Storage Service Developer Guide .
documentation (
../../index.html)
A container for one or more replication rules. A replication
configuration must have at least one rule and can contain a maximum
TABLE OF CONTENTS of 1,000 rules.
(dict) --
Quickstart
Specifies which Amazon S3 objects to replicate and where to store
the replicas.
A Sample Tutorial
ID (string) --
A unique identifier for the rule. The maximum value is 255
Code Examples characters.
Priority (integer) --
User Guides The priority associated with the rule. If you specify multiple rules in
(../../guide/index.html) a replication configuration, Amazon S3 prioritizes the rules to
prevent conflicts when filtering. If two or more rules identify the
Available Services (index.html) same object based on a specified filter, the rule with higher priority
ACM (acm.html) takes precedence. For example:
ACMPCA (acm-pca.html) Same object quality prefix based filter criteria If prefixes you
specified in multiple rules overlap
AlexaForBusiness
Same object qualify tag based filter criteria specified in multiple
rules
Amplify (amplify.html) For more information, see Cross-Region Replication (CRR)
(https://docs.aws.amazon.com/AmazonS3/latest/dev/crr.html) in
APIGateway
the Amazon S3 Developer Guide .
(apigateway.html)
Prefix (string) --
An object keyname prefix that identifies the object or objects to
Api
which the rule applies. The maximum prefix length is 1,024
characters. To include all objects in a bucket, specify an empty
api.html)
string.
Boto 3 Docs 1.9.249
Prefix (string) --
../../index.html)
An object keyname prefix that identifies the subset of objects to
which the rule applies.
TABLE OF CONTENTS
Tag (dict) --
A container for specifying a tag key and value.
Quickstart
(../../guide/quickstart.html) The rule applies only to objects that have the tag in their tag set.
A Sample Tutorial Key (string) -- [REQUIRED]
(../../guide/sqs.html) Name of the tag.
Code Examples Value (string) -- [REQUIRED]
(../../guide/examples.html) Value of the tag.
User Guides And (dict) --

(../../guide/index.html) A container for specifying rule filters. The filters determine the
subset of objects to which the rule applies. This element is
Available Services (index.html) required only if you specify more than one filter. For example:
ACM (acm.html) If you specify both a Prefix and a Tag filter, wrap these filters
ACMPCA (acm-pca.html) in an And tag.
If you specify a filter based on multiple tags, wrap the Tag
AlexaForBusiness
elements in an And tag.
Prefix (string) --
Amplify (amplify.html) Tags (list) --
(dict) --
APIGateway
(apigateway.html)
Name of the tag.
Api
Value of the tag.
api.html) Status (string) -- [REQUIRED]
Specifies whether the rule is enabled.
Boto 3 Docs 1.9.249
documentation ( SourceSelectionCriteria (dict) --
A container that describes additional filters for identifying the
../../index.html)
source objects that you want to replicate. You can choose to
enable or disable the replication of these objects. Currently,
TABLE OF CONTENTS Amazon S3 supports only the filter that you can specify for objects
created with server-side encryption using an AWS KMS-Managed
Quickstart Key (SSE-KMS).
SseKmsEncryptedObjects (dict) --
A Sample Tutorial A container for filter information for the selection of Amazon S3
(../../guide/sqs.html) objects encrypted with AWS KMS. If you include
Code Examples SourceSelectionCriteria in the replication configuration, this
(../../guide/examples.html) element is required.

User Guides
Specifies whether Amazon S3 replicates objects created with
server-side encryption using an AWS KMS-managed key.
ACM (acm.html) A container for information about the replication destination.
ACMPCA (acm-pca.html) Bucket (string) -- [REQUIRED]

The Amazon Resource Name (ARN) of the bucket where you
AlexaForBusiness
want Amazon S3 to store replicas of the object identified by the
rule.
A replication configuration can replicate objects to only one
APIGateway destination bucket. If there are multiple rules in your replication
(apigateway.html) configuration, all rules must specify the same destination bucket.
ApiGatewayManagement Account (string) --
Api Destination bucket owner account ID. In a cross-account
(apigatewaymanagement scenario, if you direct Amazon S3 to change replica ownership to
api.html) the AWS account that owns the destination bucket by specifying
the AccessControlTranslation property, this is the account ID of
Boto 3 Docs 1.9.249
the destination bucket owner. For more information, see Cross-
documentation ( Region Replication Additional Configuration: Change Replica
../../index.html) Owner (https://docs.aws.amazon.com/AmazonS3/latest/dev/crr-
change-owner.html) in the Amazon Simple Storage Service
TABLE OF CONTENTS Developer Guide .
Quickstart The storage class to use when replicating objects, such as
(../../guide/quickstart.html) standard or reduced redundancy. By default, Amazon S3 uses
A Sample Tutorial the storage class of the source object to create the object replica.
(../../guide/sqs.html) For valid values, see the StorageClass element of the PUT
Code Examples Bucket replication
(../../guide/examples.html) (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTrep
action in the Amazon Simple Storage Service API Reference .
User Guides
AccessControlTranslation (dict) --
Specify this only in a cross-account scenario (where source and
Available Services (index.html) destination bucket owners are not the same), and you want to
change replica ownership to the AWS account that owns the
ACM (acm.html)
destination bucket. If this is not specified in the replication
ACMPCA (acm-pca.html) configuration, the replicas are owned by same AWS account that
owns the source object.
AlexaForBusiness
(alexaforbusiness.html) Owner (string) -- [REQUIRED]
Specifies the replica ownership. For default and valid values,
see PUT bucket replication
APIGateway (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTr
(apigateway.html) in the Amazon Simple Storage Service API Reference .
ApiGatewayManagement EncryptionConfiguration (dict) --
Api A container that provides information about encryption. If
(apigatewaymanagement SourceSelectionCriteria is specified, you must specify this
api.html) element.
ReplicaKmsKeyID (string) --
Boto 3 Docs 1.9.249
Specifies the AWS KMS Key ID (Key ARN or Alias ARN) for the
documentation ( destination bucket. Amazon S3 uses this key to encrypt replica
../../index.html) objects.
DeleteMarkerReplication (dict) --
TABLE OF CONTENTS Status (string) --
The status of the delete marker replication.
Quickstart
Note
A Sample Tutorial
In the current implementation, Amazon S3 doesn't
replicate the delete markers. The status must be Disabled
Code Examples .
User Guides
Token (string) -- A token that allows Amazon S3 object lock to be enabled
for an existing bucket.
ACM (acm.html) None
AlexaForBusiness put_bucket_request_payment (**kwargs)

(alexaforbusiness.html) Sets the request payment configuration for a bucket. By default, the bucket
Amplify (amplify.html) owner pays for downloads from the bucket. This configuration parameter
enables the bucket owner (only) to specify that the person requesting the
APIGateway
download will be charged for the download. Documentation on requester pays
(apigateway.html)
buckets can be found at
ApiGatewayManagement http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html
Api (http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html)
api.html)
Boto 3 Docs 1.9.249
documentation ( 01/PutBucketRequestPayment)
../../index.html)
Request Syntax
TABLE OF CONTENTS
response = client.put_bucket_request_payment(
(../../guide/quickstart.html) RequestPaymentConfiguration={
'Payer': 'Requester'|'BucketOwner'
A Sample Tutorial
}
)
Code Examples
Parameters
(../../guide/index.html) RequestPaymentConfiguration (dict) --
[REQUIRED]
Payer (string) -- [REQUIRED]
ACM (acm.html)
Specifies who pays for the download and request fees.
Returns
AlexaForBusiness None
put_bucket_tagging (**kwargs)
APIGateway
Sets the tags for a bucket.
(apigateway.html)
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketTagging)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.put_bucket_tagging(
../../index.html) Tagging={
'TagSet': [
{
TABLE OF CONTENTS
'Key': 'string',
'Value': 'string'
Quickstart
},
]
A Sample Tutorial }
Code Examples
Parameters
(../../guide/index.html) Tagging (dict) --
[REQUIRED]
TagSet (list) -- [REQUIRED]
ACMPCA (acm-pca.html) Key (string) -- [REQUIRED]
Name of the tag.
AlexaForBusiness
(alexaforbusiness.html) Value (string) -- [REQUIRED]
Value of the tag.
Returns
APIGateway
None
(apigateway.html)
Api put_bucket_versioning (**kwargs)
(apigatewaymanagement Sets the versioning state of an existing bucket. To set the versioning state, you
api.html) must be the bucket owner.
Boto 3 Docs 1.9.249
documentation ( 01/PutBucketVersioning)
../../index.html)
Request Syntax
TABLE OF CONTENTS
response = client.put_bucket_versioning(
(../../guide/quickstart.html) MFA='string',
VersioningConfiguration={
A Sample Tutorial
'MFADelete': 'Enabled'|'Disabled',
Code Examples }
(../../guide/examples.html) )
User Guides
(../../guide/index.html) Parameters
ACM (acm.html) number, a space, and the value that is displayed on your authentication
device.
VersioningConfiguration (dict) --
AlexaForBusiness [REQUIRED]
MFADelete (string) --
Amplify (amplify.html) Specifies whether MFA delete is enabled in the bucket versioning
APIGateway configuration. This element is only returned if the bucket has been
(apigateway.html) configured with MFA delete. If the bucket has never been so
configured, this element is not returned.
Api Status (string) --
(apigatewaymanagement The versioning state of the bucket.
api.html) Returns
None
Boto 3 Docs 1.9.249
documentation (
../../index.html) put_bucket_website (**kwargs)
Set the website configuration for a bucket.
TABLE OF CONTENTS
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketWebsite)
Quickstart
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.put_bucket_website(
../../index.html) WebsiteConfiguration={
'ErrorDocument': {
'Key': 'string'
TABLE OF CONTENTS
},
'IndexDocument': {
Quickstart
'Suffix': 'string'
},
A Sample Tutorial 'RedirectAllRequestsTo': {
(../../guide/sqs.html) 'HostName': 'string',
Code Examples 'Protocol': 'http'|'https'
'RoutingRules': [
User Guides
{
'Condition': {
Available Services (index.html) 'HttpErrorCodeReturnedEquals': 'string',
'KeyPrefixEquals': 'string'
ACM (acm.html)
},
ACMPCA (acm-pca.html) 'Redirect': {
'HostName': 'string',
AlexaForBusiness
(alexaforbusiness.html) 'HttpRedirectCode': 'string',
'Protocol': 'http'|'https',
Amplify (amplify.html) 'ReplaceKeyPrefixWith': 'string',
APIGateway 'ReplaceKeyWith': 'string'
(apigateway.html) }
},
]
Api
}
api.html) )
Boto 3 Docs 1.9.249
Parameters
documentation ( Bucket (string) -- [REQUIRED]
../../index.html) WebsiteConfiguration (dict) --
[REQUIRED]
TABLE OF CONTENTS
The name of the error document for the website.
Quickstart
(../../guide/quickstart.html) Key (string) -- [REQUIRED]
The object key name to use when a 4XX class error occurs.
A Sample Tutorial
(../../guide/sqs.html) IndexDocument (dict) --
The name of the index document for the website.
Code Examples
(../../guide/examples.html) Suffix (string) -- [REQUIRED]
A suffix that is appended to a request that is for a directory on the
User Guides website endpoint (e.g. if the suffix is index.html and you make a
(../../guide/index.html) request to samplebucket/images/ the data that is returned will be for
the object with the key name images/index.html) The suffix must not
ACM (acm.html)
RedirectAllRequestsTo (dict) --
ACMPCA (acm-pca.html) The redirect behavior for every request to this bucket's website
endpoint.
AlexaForBusiness
Amplify (amplify.html) Warning

If you specify this property, you can't specify any other property.
APIGateway
(apigateway.html)
ApiGatewayManagement HostName (string) -- [REQUIRED]

Api Name of the host where requests are redirected.
api.html)
Protocol to use when redirecting requests. The default is the protocol
Boto 3 Docs 1.9.249
documentation (
RoutingRules (list) --
../../index.html)
Rules that define when a redirect is applied and the redirect behavior.

Quickstart Condition (dict) --
(../../guide/quickstart.html) A container for describing a condition that must be met for the
specified redirect to apply. For example, 1. If request is for pages in
A Sample Tutorial
results in HTTP error 4xx, redirect request to another host where
Code Examples you might process the error.
User Guides The HTTP error code when the redirect is applied. In the event of
(../../guide/index.html) an error, if the error code equals this value, then the specified
redirect is applied. Required when parent element Condition is
specified and sibling KeyPrefixEquals is not specified. If both are
ACM (acm.html) specified, then both must be true for the redirect to be applied.
ACMPCA (acm-pca.html) KeyPrefixEquals (string) --

AlexaForBusiness
example, to redirect requests for ExamplePage.html , the key
prefix will be ExamplePage.html . To redirect request for all
Amplify (amplify.html) pages with the prefix docs/ , the key prefix will be /docs , which
APIGateway identifies all objects in the docs/ folder. Required when the
(apigateway.html) parent element Condition is specified and sibling
HttpErrorCodeReturnedEquals is not specified. If both conditions
are specified, both must be true for the redirect to be applied.
Api
(apigatewaymanagement Redirect (dict) -- [REQUIRED]
api.html)
Boto 3 Docs 1.9.249
another host, to another page, or with another protocol. In the
documentation ( event of an error, you can specify a different error code to return.
../../index.html)
The host name to use in the redirect request.
TABLE OF CONTENTS
HttpRedirectCode (string) --
The HTTP redirect code to use on the response. Not required if
Quickstart
one of the siblings is present.
A Sample Tutorial
Protocol to use when redirecting requests. The default is the
Code Examples
ReplaceKeyPrefixWith (string) --
The object key prefix to use in the redirect request. For example,
User Guides to redirect requests for all pages with prefix docs/ (objects in the
(../../guide/index.html) docs/ folder) to documents/ , you can set a condition block with
KeyPrefixEquals set to docs/ and in the Redirect set
ReplaceKeyPrefixWith to /documents . Not required if one of the
ACM (acm.html) siblings is present. Can be present only if ReplaceKeyWith is not
provided.
AlexaForBusiness
example, redirect request to error.html . Not required if one of
Amplify (amplify.html) the siblings is present. Can be present only if
APIGateway ReplaceKeyPrefixWith is not provided.
(apigateway.html) Returns
Api
api.html) put_object (**kwargs)
Adds an object to a bucket.
Boto 3 Docs 1.9.249
documentation ( See also: AWS API Documentation
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObject)
../../index.html)
Request Syntax
TABLE OF CONTENTS
Quickstart
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.put_object(
../../index.html) Body=b'bytes'|file,
Bucket='string',
TABLE OF CONTENTS
Quickstart
ContentLength=123,
A Sample Tutorial ContentMD5='string',
(../../guide/sqs.html) ContentType='string',
Code Examples Expires=datetime(2015, 1, 1),
(../../guide/examples.html) GrantFullControl='string',
GrantRead='string',
User Guides
Available Services (index.html) Key='string',
Metadata={
ACM (acm.html)
'string': 'string'
AlexaForBusiness
(alexaforbusiness.html) StorageClass='STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|'ONEZON
Amplify (amplify.html) SSECustomerAlgorithm='string',
APIGateway SSECustomerKey='string',
(apigateway.html) SSEKMSKeyId='string',
Api
Tagging='string',
api.html) ObjectLockMode='GOVERNANCE'|'COMPLIANCE',
Boto 3 Docs 1.9.249
documentation ( )
../../index.html)

Quickstart Body (bytes or seekable file-like object) -- Object data.
(../../guide/quickstart.html) Bucket (string) --
(../../guide/sqs.html) Name of the bucket to which the PUT operation was initiated.
Code Examples CacheControl (string) -- Specifies caching behavior along the
(../../guide/examples.html) request/reply chain.
User Guides
the object.
Available Services (index.html) applied to the object and thus what decoding mechanisms must be
applied to obtain the media-type referenced by the Content-Type header
ACM (acm.html)
field.
ACMPCA (acm-pca.html) ContentLanguage (string) -- The language the content is in.
AlexaForBusiness
ContentLength (integer) -- Size of the body in bytes. This parameter is
useful when the size of the body cannot be determined automatically.
Amplify (amplify.html) part data. This parameter is auto-populated when using the command
APIGateway from the CLI. This parameted is required if object lock parameters are
(apigateway.html) specified.
ApiGatewayManagement the object data.
Api Expires (datetime) -- The date and time at which the object is no longer
(apigatewaymanagement cacheable.
api.html)
GrantFullControl (string) -- Gives the grantee READ, READ_ACP, and
Boto 3 Docs 1.9.249
documentation ( GrantRead (string) -- Allows grantee to read the object data and its
../../index.html) metadata.
TABLE OF CONTENTS GrantWriteACP (string) -- Allows grantee to write the ACL for the
applicable object.
A Sample Tutorial Object key for which the PUT operation was initiated.
(../../guide/sqs.html) Metadata (dict) --
Code Examples A map of metadata to store with the object in S3.
(../../guide/examples.html) (string) --
(string) --
User Guides
Available Services (index.html) StorageClass (string) -- The type of storage to use for the object. Defaults
to 'STANDARD'.
ACM (acm.html)
ACMPCA (acm-pca.html) website, redirects requests for this object to another object in the same
AlexaForBusiness
in the object metadata.
Amplify (amplify.html) encrypting the object (e.g., AES256).
APIGateway
(apigateway.html)
ApiGatewayManagement key. The key must be appropriate for use with the algorithm specified in
Api the x-amz-server-side-encryption-customer-algorithm header.
(apigatewaymanagement SSECustomerKeyMD5 (string) --
api.html)
Boto 3 Docs 1.9.249
documentation ( ensure the encryption key was transmitted without error.
../../index.html)

TABLE OF CONTENTS
Quickstart
(../../guide/quickstart.html) SSEKMSKeyId (string) -- Specifies the AWS KMS key ID to use for object
A Sample Tutorial
Code Examples http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-
(../../guide/examples.html) signature-version
(http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify
User Guides
signature-version)
Available Services (index.html) Context to use for object encryption. The value of this header is a base64-
ACM (acm.html)
pairs.
ACMPCA (acm-pca.html) RequestPayer (string) -- Confirms that the requester knows that she or
AlexaForBusiness
Amplify (amplify.html) http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
APIGateway
Tagging (string) -- The tag-set for the object. The tag-set must be encoded
(apigateway.html)
as URL Query parameters. (For example, "Key1=Value1")
ApiGatewayManagement ObjectLockMode (string) -- The object lock mode that you want to apply
Api to this object.
(apigatewaymanagement ObjectLockRetainUntilDate (datetime) -- The date and time when you
api.html) want this object's object lock to expire.
ObjectLockLegalHoldStatus (string) -- The Legal Hold status that you
Boto 3 Docs 1.9.249
want to apply to the specified object.
documentation (
Return type
../../index.html)
dict
Response Syntax
Quickstart
{
A Sample Tutorial 'Expiration': 'string',
(../../guide/sqs.html) 'ETag': 'string',
Code Examples 'ServerSideEncryption': 'AES256'|'aws:kms',
(../../guide/examples.html) 'VersionId': 'string',
User Guides
Available Services (index.html) 'SSEKMSEncryptionContext': 'string',
ACM (acm.html)
}

(dict) --
APIGateway
(apigateway.html) 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
ApiGatewayManagement encoded.
Api
(apigatewaymanagement ETag (string) --
api.html) Entity tag for the uploaded object.
Boto 3 Docs 1.9.249
documentation ( The Server-side encryption algorithm used when storing this object in
../../index.html)
TABLE OF CONTENTS Version of the object.
Quickstart
(../../guide/quickstart.html) If server-side encryption with a customer-provided encryption key was
A Sample Tutorial
Code Examples
(../../guide/examples.html) If server-side encryption with a customer-provided encryption key was
User Guides message integrity verification of the customer-provided encryption key.
ACM (acm.html) master encryption key that was used for the object.
ACMPCA (acm-pca.html) SSEKMSEncryptionContext (string) --
AlexaForBusiness If present, specifies the AWS KMS Encryption Context to use for object
(alexaforbusiness.html) encryption. The value of this header is a base64-encoded UTF-8 string
Amplify (amplify.html) holding JSON with the encryption context key-value pairs.

Api
api.html) put_object_acl (**kwargs)
uses the acl subresource to set the access control list (ACL) permissions for an
Boto 3 Docs 1.9.249
object that already exists in a bucket
documentation (
../../index.html)
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectAcl)
Quickstart
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.put_object_acl(
'Grants': [
{
TABLE OF CONTENTS
'Grantee': {
Quickstart
'ID': 'string',
Code Examples },
},
User Guides
],
'Owner': {
'ID': 'string'
ACM (acm.html)
}
Bucket='string',
AlexaForBusiness
(alexaforbusiness.html) GrantFullControl='string',
GrantRead='string',
Amplify (amplify.html) GrantReadACP='string',
APIGateway GrantWrite='string',
(apigateway.html) GrantWriteACP='string',
Key='string',
Api
VersionId='string'
api.html) )
Boto 3 Docs 1.9.249
../../index.html) ACL (string) -- The canned ACL to apply to the object.
TABLE OF CONTENTS Contains the elements that set the ACL permissions for an object per
grantee.
Quickstart Grants (list) --
(../../guide/quickstart.html) A list of grants.
(../../guide/sqs.html) Grantee (dict) --
Code Examples
User Guides
ID (string) --
Available Services (index.html) The canonical user ID of the grantee.
ACM (acm.html) Type (string) -- [REQUIRED]
ACMPCA (acm-pca.html) Type of grantee
AlexaForBusiness URI (string) --

(alexaforbusiness.html) URI of the grantee group.
Amplify (amplify.html) Permission (string) --

APIGateway
(apigateway.html) Owner (dict) --
Container for the bucket owner's display name and ID.
Api DisplayName (string) --
(apigatewaymanagement ID (string) --
GrantFullControl (string) -- Allows grantee the read, write, read ACP, and
Boto 3 Docs 1.9.249
write ACP permissions on the bucket.
documentation ( GrantRead (string) -- Allows grantee to list the objects in the bucket.
../../index.html) GrantReadACP (string) -- Allows grantee to read the bucket ACL.
TABLE OF CONTENTS object in the bucket.
Quickstart applicable bucket.
(../../guide/quickstart.html) Key (string) -- [REQUIRED]
A Sample Tutorial he will be charged for the request. Bucket owners need not specify this
(../../guide/sqs.html) parameter in their requests. Documentation on downloading objects
Code Examples from requester pays buckets can be found at
(../../guide/examples.html) http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
User Guides VersionId (string) -- VersionId used to reference a specific version of the
(../../guide/index.html) object.

dict
ACM (acm.html)
Returns
Response Syntax
AlexaForBusiness
APIGateway }
(apigateway.html)
Response Structure
Api
(apigatewaymanagement (dict) --
api.html)
Boto 3 Docs 1.9.249
request.
../../index.html)
TABLE OF CONTENTS put_object_legal_hold (**kwargs)

Applies a Legal Hold configuration to the specified object.
Quickstart
(../../guide/quickstart.html) See also: AWS API Documentation
A Sample Tutorial
01/PutObjectLegalHold)
Request Syntax
Code Examples
response = client.put_object_legal_hold(
(../../guide/index.html) Key='string',
Available Services (index.html) LegalHold={
'Status': 'ON'|'OFF'
ACM (acm.html)
},
ACMPCA (acm-pca.html) RequestPayer='requester',
VersionId='string',
AlexaForBusiness
ContentMD5='string'
)
APIGateway
Parameters
(apigateway.html)
Bucket (string) --
Api
The bucket containing the object that you want to place a Legal Hold on.
api.html) Key (string) --
[REQUIRED]
Boto 3 Docs 1.9.249
documentation ( The key name for the object that you want to place a Legal Hold on.
../../index.html) LegalHold (dict) --

Container element for the Legal Hold configuration you want to apply to
TABLE OF CONTENTS the specified object.
Status (string) --
Quickstart Indicates whether the specified object has a Legal Hold in place.
A Sample Tutorial he will be charged for the request. Bucket owners need not specify this
(../../guide/sqs.html) parameter in their requests. Documentation on downloading objects
Code Examples
User Guides VersionId (string) -- The version ID of the object that you want to place a
(../../guide/index.html) Legal Hold on.
ContentMD5 (string) -- The MD5 hash for the request body.
Return type
ACM (acm.html)
dict
Returns
AlexaForBusiness
Response Syntax
{
APIGateway 'RequestCharged': 'requester'
(apigateway.html) }
api.html) (dict) --
Boto 3 Docs 1.9.249
request.
../../index.html)
TABLE OF CONTENTS put_object_lock_configuration (**kwargs)

Places an object lock configuration on the specified bucket. The rule specified in
Quickstart
the object lock configuration will be applied by default to every new object
A Sample Tutorial
Code Examples 01/PutObjectLockConfiguration)
Request Syntax
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.put_object_lock_configuration(
../../index.html) ObjectLockConfiguration={
'ObjectLockEnabled': 'Enabled',
'Rule': {
TABLE OF CONTENTS
'DefaultRetention': {
Quickstart
'Days': 123,
'Years': 123
A Sample Tutorial }
Code Examples },
Token='string',
User Guides
ContentMD5='string'
)
ACM (acm.html) Parameters

Bucket (string) --
[REQUIRED]
AlexaForBusiness
The bucket whose object lock configuration you want to create or
replace.
ObjectLockConfiguration (dict) --
APIGateway The object lock configuration that you want to apply to the specified
(apigateway.html) bucket.
ApiGatewayManagement ObjectLockEnabled (string) --
Api Indicates whether this bucket has an object lock configuration enabled.
Rule (dict) --
api.html)
The object lock rule in place for the specified object.
Boto 3 Docs 1.9.249
documentation ( DefaultRetention (dict) --
The default retention period that you want to apply to new objects
../../index.html)
TABLE OF CONTENTS Mode (string) --

The default object lock retention mode you want to apply to new
objects placed in the specified bucket.
Quickstart
(../../guide/quickstart.html) Days (integer) --
The number of days that you want to specify for the default
A Sample Tutorial
retention period.
Years (integer) --
Code Examples
The number of years that you want to specify for the default
retention period.
User Guides
Available Services (index.html) parameter in their requests. Documentation on downloading objects
ACM (acm.html) http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
ACMPCA (acm-pca.html) (http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
Token (string) -- A token to allow Amazon S3 object lock to be enabled for
AlexaForBusiness
an existing bucket.
ContentMD5 (string) -- The MD5 hash for the request body.
Return type
APIGateway dict
(apigateway.html)
Returns
Response Syntax
Api
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'RequestCharged': 'requester'
../../index.html) }
TABLE OF CONTENTS Response Structure
(dict) --
Quickstart
(../../guide/quickstart.html) RequestCharged (string) --
A Sample Tutorial If present, indicates that the requester was successfully charged for the
(../../guide/sqs.html) request.
Code Examples
put_object_retention (**kwargs)
User Guides Places an Object Retention configuration on an object.
Available Services (index.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-
01/PutObjectRetention)
ACM (acm.html)
Request Syntax
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.put_object_retention(
Retention={
TABLE OF CONTENTS
'RetainUntilDate': datetime(2015, 1, 1)
},
Quickstart
VersionId='string',
A Sample Tutorial BypassGovernanceRetention=True|False,
(../../guide/sqs.html) ContentMD5='string'
Code Examples )
User Guides Parameters

(../../guide/index.html) Bucket (string) --
[REQUIRED]
The bucket that contains the object you want to apply this Object
ACM (acm.html)
Retention configuration to.
Key (string) --
The key name for the object that you want to apply this Object Retention
Amplify (amplify.html) configuration to.
APIGateway Retention (dict) --

(apigateway.html) The container element for the Object Retention configuration.
ApiGatewayManagement Mode (string) --

Api Indicates the Retention mode for the specified object.
RetainUntilDate (datetime) --
api.html)
The date on which this object lock retention expires.
Boto 3 Docs 1.9.249
documentation ( parameter in their requests. Documentation on downloading objects
../../index.html) from requester pays buckets can be found at
TABLE OF CONTENTS (http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
VersionId (string) -- The version ID for the object that you want to apply
Quickstart this Object Retention configuration to.
(../../guide/quickstart.html) BypassGovernanceRetention (boolean) -- Indicates whether this
operation should bypass Governance-mode restrictions.j
A Sample Tutorial ContentMD5 (string) -- The MD5 hash for the request body.
Return type
Code Examples
dict
Returns
User Guides
Response Syntax

{
ACM (acm.html) 'RequestCharged': 'requester'
AlexaForBusiness

Api
api.html) put_object_tagging (**kwargs)
Sets the supplied tag-set to an object that already exists in a bucket
Boto 3 Docs 1.9.249
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectTagging)
../../index.html)
Request Syntax
TABLE OF CONTENTS
response = client.put_object_tagging(
(../../guide/quickstart.html) Key='string',
A Sample Tutorial VersionId='string',
(../../guide/sqs.html) ContentMD5='string',
Tagging={
Code Examples
'TagSet': [
{
User Guides 'Key': 'string',
(../../guide/index.html) 'Value': 'string'
},
]
ACM (acm.html) }
)
AlexaForBusiness
APIGateway VersionId (string) --
(apigateway.html) ContentMD5 (string) --
Tagging (dict) --
[REQUIRED]
Api
(apigatewaymanagement TagSet (list) -- [REQUIRED]
api.html) (dict) --
Boto 3 Docs 1.9.249
Name of the tag.
documentation (
../../index.html)
Value of the tag.

dict
Quickstart Returns
Response Syntax
A Sample Tutorial
{
Code Examples 'VersionId': 'string'
User Guides
ACM (acm.html) VersionId (string) --
AlexaForBusiness put_public_access_block (**kwargs)

(alexaforbusiness.html) Creates or modifies the PublicAccessBlock configuration for an Amazon S3
bucket.
APIGateway
(apigateway.html)
01/PutPublicAccessBlock)
Request Syntax
Api
api.html)
Boto 3 Docs 1.9.249 response = client.put_public_access_block(
../../index.html) ContentMD5='string',
PublicAccessBlockConfiguration={
'BlockPublicAcls': True|False,
TABLE OF CONTENTS
'IgnorePublicAcls': True|False,
'BlockPublicPolicy': True|False,
Quickstart
'RestrictPublicBuckets': True|False
}
A Sample Tutorial )
Code Examples
Parameters
Bucket (string) --
User Guides [REQUIRED]
The name of the Amazon S3 bucket whose PublicAccessBlock
Available Services (index.html) configuration you want to set.
ACM (acm.html) ContentMD5 (string) -- The MD5 hash of the PutPublicAccessBlock

request body.
PublicAccessBlockConfiguration (dict) --
The PublicAccessBlock configuration that you want to apply to this
Amplify (amplify.html) Amazon S3 bucket. You can enable the configuration options in any
combination. For more information about when Amazon S3 considers a
APIGateway
bucket or object public, see The Meaning of "Public"
(apigateway.html)
(https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-
ApiGatewayManagement block-public-access.html#access-control-block-public-access-policy-
Api status) in the Amazon Simple Storage Service Developer Guide .
BlockPublicAcls (boolean) --
api.html)
Specifies whether Amazon S3 should block public access control lists
Boto 3 Docs 1.9.249
(ACLs) for this bucket and objects in this bucket. Setting this element to
documentation ( TRUE causes the following behavior:
../../index.html)
PUT Bucket acl and PUT Object acl calls fail if the specified ACL is
public.
TABLE OF CONTENTS
PUT Object calls fail if the request includes a public ACL.
Enabling this setting doesn't affect existing policies or ACLs.
Quickstart
IgnorePublicAcls (boolean) --
Specifies whether Amazon S3 should ignore public ACLs for this bucket
A Sample Tutorial and objects in this bucket. Setting this element to TRUE causes Amazon
(../../guide/sqs.html) S3 to ignore all public ACLs on this bucket and objects in this bucket.
Code Examples Enabling this setting doesn't affect the persistence of any existing ACLs
(../../guide/examples.html) and doesn't prevent new public ACLs from being set.
User Guides BlockPublicPolicy (boolean) --
(../../guide/index.html) Specifies whether Amazon S3 should block public bucket policies for
this bucket. Setting this element to TRUE causes Amazon S3 to reject
calls to PUT Bucket policy if the specified bucket policy allows public
ACM (acm.html) access.
ACMPCA (acm-pca.html) Enabling this setting doesn't affect existing bucket policies.
AlexaForBusiness RestrictPublicBuckets (boolean) --
(alexaforbusiness.html) Specifies whether Amazon S3 should restrict public bucket policies for
this bucket. Setting this element to TRUE restricts access to this bucket
to only AWS services and authorized users within this account if the
APIGateway bucket has a public policy.
(apigateway.html)
Enabling this setting doesn't affect previously stored bucket policies,
ApiGatewayManagement except that public and cross-account access within any public bucket
Api policy, including non-public delegation to specific accounts, is blocked.
Returns
api.html)
None
Boto 3 Docs 1.9.249
documentation (
../../index.html) restore_object (**kwargs)
Restores an archived copy of an object back into Amazon S3
TABLE OF CONTENTS
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreObject)
Quickstart
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.restore_object(
VersionId='string',
RestoreRequest={
TABLE OF CONTENTS
'Days': 123,
'GlacierJobParameters': {
Quickstart
'Tier': 'Standard'|'Bulk'|'Expedited'
},
A Sample Tutorial 'Type': 'SELECT',
(../../guide/sqs.html) 'Tier': 'Standard'|'Bulk'|'Expedited',
Code Examples 'Description': 'string',
(../../guide/examples.html) 'SelectParameters': {
'InputSerialization': {
User Guides
'CSV': {
'FileHeaderInfo': 'USE'|'IGNORE'|'NONE',
Available Services (index.html) 'Comments': 'string',
'QuoteEscapeCharacter': 'string',
ACM (acm.html)
'RecordDelimiter': 'string',
ACMPCA (acm-pca.html) 'FieldDelimiter': 'string',
'QuoteCharacter': 'string',
AlexaForBusiness
(alexaforbusiness.html) 'AllowQuotedRecordDelimiter': True|False
},
Amplify (amplify.html) 'CompressionType': 'NONE'|'GZIP'|'BZIP2',
APIGateway 'JSON': {
(apigateway.html) 'Type': 'DOCUMENT'|'LINES'
},
'Parquet': {}
Api
api.html) },
'ExpressionType': 'SQL',
Boto 3 Docs 1.9.249
'Expression': 'string',
documentation ( 'OutputSerialization': {
../../index.html) 'CSV': {
'QuoteFields': 'ALWAYS'|'ASNEEDED',
TABLE OF CONTENTS 'QuoteEscapeCharacter': 'string',
Quickstart 'FieldDelimiter': 'string',
(../../guide/quickstart.html) 'QuoteCharacter': 'string'
},
A Sample Tutorial
'JSON': {
'RecordDelimiter': 'string'
Code Examples }
User Guides },
(../../guide/index.html) 'OutputLocation': {
'S3': {
Available Services (index.html) 'BucketName': 'string',
ACM (acm.html) 'Prefix': 'string',
'Encryption': {
'EncryptionType': 'AES256'|'aws:kms',
AlexaForBusiness 'KMSKeyId': 'string',
(alexaforbusiness.html) 'KMSContext': 'string'
'CannedACL': 'private'|'public-read'|'public-read-writ
APIGateway 'AccessControlList': [
(apigateway.html)
{
ApiGatewayManagement 'Grantee': {
Api 'DisplayName': 'string',
(apigatewaymanagement 'EmailAddress': 'string',
api.html) 'ID': 'string',
'Type': 'CanonicalUser'|'AmazonCustomerByE
Boto 3 Docs 1.9.249
'URI': 'string'
documentation ( },
../../index.html) 'Permission': 'FULL_CONTROL'|'WRITE'|'WRITE_AC
},
TABLE OF CONTENTS ],
'Tagging': {
Quickstart 'TagSet': [
'Key': 'string',
A Sample Tutorial
'Value': 'string'
},
Code Examples ]
User Guides 'UserMetadata': [
(../../guide/index.html) {
'Name': 'string',
ACM (acm.html) },
],
AlexaForBusiness }
APIGateway )
(apigateway.html)
Api Parameters
api.html)
Boto 3 Docs 1.9.249
documentation ( RestoreRequest (dict) --
../../index.html) Days (integer) --
Lifetime of the active copy in days. Do not use with restores that specify
TABLE OF CONTENTS OutputLocation.
GlacierJobParameters (dict) --
Quickstart Glacier related parameters pertaining to this job. Do not use with
(../../guide/quickstart.html) restores that specify OutputLocation.
A Sample Tutorial Tier (string) -- [REQUIRED]
(../../guide/sqs.html) Glacier retrieval tier at which the restore will be processed.
Code Examples Type (string) --
(../../guide/examples.html) Type of restore request.
User Guides Tier (string) --

(../../guide/index.html) Glacier retrieval tier at which the restore will be processed.
Available Services (index.html) Description (string) --

The optional description for the job.
ACM (acm.html)
SelectParameters (dict) --
ACMPCA (acm-pca.html) Describes the parameters for Select job types.
AlexaForBusiness InputSerialization (dict) -- [REQUIRED]
(alexaforbusiness.html) Describes the serialization format of the object.
Amplify (amplify.html) CSV (dict) --
APIGateway Describes the serialization of a CSV-encoded object.
(apigateway.html) FileHeaderInfo (string) --
ApiGatewayManagement Describes the first line of input. Valid values: None, Ignore, Use.
Api Comments (string) --
(apigatewaymanagement The single character used to indicate a row should be ignored
api.html) when present at the start of a row.
QuoteEscapeCharacter (string) --
Boto 3 Docs 1.9.249
The single character used for escaping the quote character
documentation ( inside an already escaped value.
../../index.html)
RecordDelimiter (string) --
The value used to separate individual records.
TABLE OF CONTENTS
FieldDelimiter (string) --
The value used to separate individual fields in a record.
Quickstart
(../../guide/quickstart.html) QuoteCharacter (string) --
Value used for escaping where the field delimiter is part of the
A Sample Tutorial
value.
AllowQuotedRecordDelimiter (boolean) --
Code Examples
Specifies that CSV field values may contain quoted record
delimiters and such records should be allowed. Default value is
User Guides FALSE. Setting this value to TRUE may lower performance.
CompressionType (string) --
Available Services (index.html) Specifies object's compression format. Valid values: NONE, GZIP,
BZIP2. Default Value: NONE.
ACM (acm.html)
JSON (dict) --
ACMPCA (acm-pca.html) Specifies JSON as object's input serialization format.
AlexaForBusiness Type (string) --
(alexaforbusiness.html) The type of JSON. Valid values: Document, Lines.
Amplify (amplify.html) Parquet (dict) --
APIGateway Specifies Parquet as object's input serialization format.
(apigateway.html) ExpressionType (string) -- [REQUIRED]
ApiGatewayManagement The type of the provided expression (e.g., SQL).
Api Expression (string) -- [REQUIRED]
(apigatewaymanagement The expression that is used to query the object.
api.html)
OutputSerialization (dict) -- [REQUIRED]
Boto 3 Docs 1.9.249
Describes how the results of the Select job are serialized.
documentation (
CSV (dict) --
../../index.html)
Describes the serialization of CSV-encoded Select results.
TABLE OF CONTENTS QuoteFields (string) --

Indicates whether or not all output fields should be quoted.
Quickstart QuoteEscapeCharacter (string) --
(../../guide/quickstart.html) Th single character used for escaping the quote character inside
an already escaped value.
A Sample Tutorial
(../../guide/sqs.html) RecordDelimiter (string) --
Code Examples
(../../guide/examples.html) FieldDelimiter (string) --
User Guides
(../../guide/index.html) QuoteCharacter (string) --
The value used for escaping where the field delimiter is part of
Available Services (index.html) the value.
ACM (acm.html) JSON (dict) --
ACMPCA (acm-pca.html) Specifies JSON as request's output serialization format.
AlexaForBusiness RecordDelimiter (string) --

(alexaforbusiness.html) The value used to separate individual records in the output.
Amplify (amplify.html) OutputLocation (dict) --

Describes the location where the restore job's output is stored.
APIGateway
(apigateway.html) S3 (dict) --
Describes an S3 location that will receive the results of the restore
Api
(apigatewaymanagement BucketName (string) -- [REQUIRED]
api.html) The name of the bucket where the restore results will be placed.
Boto 3 Docs 1.9.249
The prefix that is prepended to the restore results for this request.
documentation (
Encryption (dict) --
../../index.html)
EncryptionType (string) -- [REQUIRED]
The server-side encryption algorithm used when storing job
TABLE OF CONTENTS results in Amazon S3 (e.g., AES256, aws:kms).
KMSKeyId (string) --
Quickstart
If the encryption type is aws:kms, this optional value specifies
the AWS KMS key ID to use for encryption of job results.
A Sample Tutorial
KMSContext (string) --
If the encryption type is aws:kms, this optional value can be used
Code Examples to specify the encryption context for the restore results.
CannedACL (string) --
User Guides The canned ACL to apply to the restore results.
AccessControlList (list) --
Available Services (index.html) A list of grants that control access to the staged results.

Grantee (dict) --
ACMPCA (acm-pca.html) DisplayName (string) --
AlexaForBusiness Screen name of the grantee.
(alexaforbusiness.html) EmailAddress (string) --
Amplify (amplify.html) Email address of the grantee.
(apigateway.html) The canonical user ID of the grantee.
ApiGatewayManagement Type (string) -- [REQUIRED]

Api Type of grantee
(apigatewaymanagement URI (string) --
api.html) URI of the grantee group.
Boto 3 Docs 1.9.249
documentation (
Tagging (dict) --
../../index.html)
The tag-set that is applied to the restore results.
TABLE OF CONTENTS TagSet (list) -- [REQUIRED]

(dict) --
Quickstart
Name of the tag.
A Sample Tutorial
Value of the tag.
UserMetadata (list) --
Code Examples
A list of metadata to store with the restore results in S3.
(dict) --
User Guides
A metadata key-value pair to store with an object.
Name (string) --
Available Services (index.html) Value (string) --
The class of storage used to store the restore results.
AlexaForBusiness he will be charged for the request. Bucket owners need not specify this
(alexaforbusiness.html) parameter in their requests. Documentation on downloading objects
APIGateway
(apigateway.html)
Return type
dict
Api
api.html)
Response Syntax
Boto 3 Docs 1.9.249
documentation (
{
../../index.html)
'RestoreOutputPath': 'string'
TABLE OF CONTENTS
}
Quickstart
(../../guide/quickstart.html) Response Structure

Code Examples
request.
User Guides RestoreOutputPath (string) --
Indicates the path in the provided S3 output location where Select
Available Services (index.html) results will be restored to.
ACM (acm.html)
ACMPCA (acm-pca.html) select_object_content (**kwargs)

AlexaForBusiness This operation filters the contents of an Amazon S3 object based on a simple
(alexaforbusiness.html) Structured Query Language (SQL) statement. In the request, along with the SQL
expression, you must also specify a data serialization format (JSON or CSV) of
the object. Amazon S3 uses this to parse object data into records, and returns
APIGateway only records that match the specified SQL expression. You must also specify the
(apigateway.html) data serialization format for the response.
(apigatewaymanagement 01/SelectObjectContent)
api.html)
Request Syntax
Boto 3 Docs 1.9.249
documentation (
../../index.html)
TABLE OF CONTENTS
Quickstart
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.select_object_content(
TABLE OF CONTENTS
Expression='string',
ExpressionType='SQL',
Quickstart
RequestProgress={
'Enabled': True|False
(../../guide/sqs.html) InputSerialization={
Code Examples 'CSV': {
(../../guide/examples.html) 'FileHeaderInfo': 'USE'|'IGNORE'|'NONE',
'Comments': 'string',
User Guides
Available Services (index.html) 'FieldDelimiter': 'string',
ACM (acm.html)
'AllowQuotedRecordDelimiter': True|False
'CompressionType': 'NONE'|'GZIP'|'BZIP2',
AlexaForBusiness
(alexaforbusiness.html) 'JSON': {
'Type': 'DOCUMENT'|'LINES'
APIGateway 'Parquet': {}
(apigateway.html)
},
OutputSerialization={
Api
'CSV': {
api.html) 'QuoteFields': 'ALWAYS'|'ASNEEDED',
Boto 3 Docs 1.9.249
documentation ( 'FieldDelimiter': 'string',
../../index.html) 'QuoteCharacter': 'string'
},
TABLE OF CONTENTS 'JSON': {
Quickstart }
)
A Sample Tutorial

(../../guide/examples.html) Bucket (string) --
[REQUIRED]
User Guides
(../../guide/index.html) The S3 bucket.
Key (string) --
[REQUIRED]
ACM (acm.html)
The object key.
SSECustomerAlgorithm (string) -- The SSE Algorithm used to encrypt the
AlexaForBusiness object. For more information, see Server-Side Encryption (Using
(alexaforbusiness.html) Customer-Provided Encryption Keys
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCusto
.
APIGateway SSECustomerKey (string) -- The SSE Customer Key. For more information,
(apigateway.html) see Server-Side Encryption (Using Customer-Provided Encryption Keys
ApiGatewayManagement (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCusto
Api .
(apigatewaymanagement SSECustomerKeyMD5 (string) --
api.html)
The SSE Customer Key MD5. For more information, see Server-Side
Boto 3 Docs 1.9.249
Encryption (Using Customer-Provided Encryption Keys
documentation ( (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCusto
../../index.html) .
TABLE OF CONTENTS
Quickstart
Expression (string) --
A Sample Tutorial
[REQUIRED]
The expression that is used to query the object.
Code Examples
(../../guide/examples.html) ExpressionType (string) --
[REQUIRED]
User Guides
(../../guide/index.html) The type of the provided expression (for example., SQL).

RequestProgress (dict) --
Specifies if periodic request progress information should be enabled.
ACM (acm.html)
Enabled (boolean) --
ACMPCA (acm-pca.html) Specifies whether periodic QueryProgress frames should be sent. Valid
AlexaForBusiness values: TRUE, FALSE. Default value: FALSE.
(alexaforbusiness.html) InputSerialization (dict) --
Amplify (amplify.html) [REQUIRED]
APIGateway Describes the format of the data in the object that is being queried.
(apigateway.html) CSV (dict) --
ApiGatewayManagement Describes the serialization of a CSV-encoded object.
Api FileHeaderInfo (string) --
(apigatewaymanagement Describes the first line of input. Valid values: None, Ignore, Use.
api.html)
Comments (string) --
Boto 3 Docs 1.9.249
The single character used to indicate a row should be ignored when
documentation ( present at the start of a row.
../../index.html)
The single character used for escaping the quote character inside an
TABLE OF CONTENTS already escaped value.
Quickstart
A Sample Tutorial
QuoteCharacter (string) --
Code Examples
Value used for escaping where the field delimiter is part of the value.
AllowQuotedRecordDelimiter (boolean) --
User Guides
Specifies that CSV field values may contain quoted record delimiters
and such records should be allowed. Default value is FALSE. Setting
Available Services (index.html) this value to TRUE may lower performance.
ACM (acm.html) CompressionType (string) --

Specifies object's compression format. Valid values: NONE, GZIP, BZIP2.
ACMPCA (acm-pca.html) Default Value: NONE.
AlexaForBusiness JSON (dict) --
(alexaforbusiness.html) Specifies JSON as object's input serialization format.
Amplify (amplify.html) Type (string) --
APIGateway The type of JSON. Valid values: Document, Lines.
(apigateway.html) Parquet (dict) --
ApiGatewayManagement Specifies Parquet as object's input serialization format.
Api OutputSerialization (dict) --
(apigatewaymanagement [REQUIRED]
api.html)
Describes the format of the data that you want Amazon S3 to return in
Boto 3 Docs 1.9.249
response.
documentation (
CSV (dict) --
../../index.html)
TABLE OF CONTENTS QuoteFields (string) --

Quickstart QuoteEscapeCharacter (string) --
(../../guide/quickstart.html) Th single character used for escaping the quote character inside an
already escaped value.
A Sample Tutorial
(../../guide/sqs.html) RecordDelimiter (string) --
Code Examples
(../../guide/examples.html) FieldDelimiter (string) --
User Guides
(../../guide/index.html) QuoteCharacter (string) --
The value used for escaping where the field delimiter is part of the
Available Services (index.html) value.
ACM (acm.html) JSON (dict) --
ACMPCA (acm-pca.html) Specifies JSON as request's output serialization format.
AlexaForBusiness RecordDelimiter (string) --

(alexaforbusiness.html) The value used to separate individual records in the output.
Amplify (amplify.html) Return type

dict
APIGateway
ApiGatewayManagement The response of this operation contains an EventStream member. When

Api iterated the EventStream will yield events based on the structure below,
(apigatewaymanagement where only one of the top level keys will be present for any given event.
api.html)
Response Syntax
Boto 3 Docs 1.9.249
documentation (
{
../../index.html)
'Payload': EventStream({
'Records': {
TABLE OF CONTENTS
'Payload': b'bytes'
},
Quickstart
'Stats': {
'Details': {
A Sample Tutorial 'BytesScanned': 123,
(../../guide/sqs.html) 'BytesProcessed': 123,
Code Examples 'BytesReturned': 123
},
User Guides 'Progress': {
(../../guide/index.html) 'Details': {
'BytesScanned': 123,
'BytesProcessed': 123,
ACM (acm.html) 'BytesReturned': 123
},
AlexaForBusiness
'Cont': {},
'End': {}
Amplify (amplify.html) })
APIGateway }
(apigateway.html)
ApiGatewayManagement Response Structure

Api
(dict) --
api.html) Payload ( EventStream ) --
Records (dict) --
Boto 3 Docs 1.9.249
documentation ( The Records Event.
../../index.html) Payload (bytes) --
The byte array of partial, one or more result records.

TABLE OF CONTENTS
Stats (dict) --
Quickstart The Stats Event.

Details (dict) --
A Sample Tutorial
The Stats event details.
BytesScanned (integer) --
Code Examples
(../../guide/examples.html) The total number of object bytes scanned.
User Guides BytesProcessed (integer) --

(../../guide/index.html) The total number of uncompressed object bytes processed.
Available Services (index.html) BytesReturned (integer) --
ACM (acm.html) The total number of bytes of records payload data returned.
ACMPCA (acm-pca.html) Progress (dict) --
AlexaForBusiness The Progress Event.

Details (dict) --
The Progress event details.
APIGateway
BytesScanned (integer) --
(apigateway.html)
The current number of object bytes scanned.
Api BytesProcessed (integer) --
(apigatewaymanagement The current number of uncompressed object bytes processed.
api.html)
BytesReturned (integer) --
Boto 3 Docs 1.9.249
documentation ( The current number of bytes of records payload data returned.
../../index.html) Cont (dict) --
The Continuation Event.

TABLE OF CONTENTS
End (dict) --
Quickstart The End Event.

A Sample Tutorial
upload_file (Filename, Bucket, Key, ExtraArgs=None, Callback=None,
Config=None)
Code Examples
Upload a file to an S3 object.
Usage:
User Guides
import boto3
Available Services (index.html) s3 = boto3.resource('s3')
ACM (acm.html) s3.meta.client.upload_file('/tmp/hello.txt', 'mybucket', 'hello.txt')
Similar behavior as S3Transfer's upload_file() method, except that parameters
AlexaForBusiness
are capitalized. Detailed examples can be found at S3Transfer's Usage.
Parameters
Filename (str) -- The path to the file to upload.
APIGateway Bucket (str) -- The name of the bucket to upload to.
(apigateway.html) Key (str) -- The name of the key to upload to.
ApiGatewayManagement ExtraArgs (dict) -- Extra arguments that may be passed to the client
Api operation.
(apigatewaymanagement Callback (function) -- A method which takes a number of bytes
api.html) transferred to be periodically called during the upload.
Boto 3 Docs 1.9.249
documentation ( transfer configuration to be used when performing the transfer.
../../index.html)
TABLE OF CONTENTS upload_fileobj (Fileobj, Bucket, Key, ExtraArgs=None, Callback=None,

Config=None)
Quickstart Upload a file-like object to S3.
A Sample Tutorial
This is a managed transfer which will perform a multipart upload in multiple
Code Examples
Usage:
User Guides
import boto3
with open('filename', 'rb') as data:
ACM (acm.html)
s3.upload_fileobj(data, 'mybucket', 'mykey')
Fileobj (a file-like object) -- A file-like object to upload. At a minimum, it
Amplify (amplify.html) must implement the read method, and must return bytes.
Bucket (str) -- The name of the bucket to upload to.
APIGateway
Key (str) -- The name of the key to upload to.
(apigateway.html)
ApiGatewayManagement operation.
Api Callback (function) -- A method which takes a number of bytes
(apigatewaymanagement transferred to be periodically called during the upload.
api.html)
Boto 3 Docs 1.9.249
documentation ( transfer configuration to be used when performing the upload.
../../index.html)
TABLE OF CONTENTS upload_part (**kwargs)

Uploads a part in a multipart upload.
Quickstart
Note: After you initiate multipart upload and upload one or more parts,
A Sample Tutorial you must either complete or abort multipart upload in order to stop
(../../guide/sqs.html) getting charged for storage of the uploaded parts. Only after you either
Code Examples complete or abort multipart upload, Amazon S3 frees up the parts storage
(../../guide/examples.html) and stops charging you for the parts storage.
User Guides
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPart)
Request Syntax
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.upload_part(
documentation ( Body=b'bytes'|file,
ContentLength=123,
TABLE OF CONTENTS
Key='string',
PartNumber=123,
Quickstart
UploadId='string',
A Sample Tutorial SSECustomerKey='string',
(../../guide/sqs.html) RequestPayer='requester'
Code Examples )

(../../guide/index.html) Body (bytes or seekable file-like object) -- Object data.
Bucket (string) --
[REQUIRED]
ACM (acm.html)
Name of the bucket to which the multipart upload was initiated.
AlexaForBusiness useful when the size of the body cannot be determined automatically.
(alexaforbusiness.html) ContentMD5 (string) -- The base64-encoded 128-bit MD5 digest of the
part data. This parameter is auto-populated when using the command
from the CLI. This parameted is required if object lock parameters are
APIGateway specified.
(apigateway.html) Key (string) --
[REQUIRED]
Api Object key for which the multipart upload was initiated.
api.html)
[REQUIRED]
Boto 3 Docs 1.9.249
documentation ( Part number of part being uploaded. This is a positive integer between 1
and 10,000.
../../index.html)
TABLE OF CONTENTS [REQUIRED]
Upload ID identifying the multipart upload whose part is being uploaded.
Quickstart
A Sample Tutorial SSECustomerKey (string) -- Specifies the customer-provided encryption
(../../guide/sqs.html) key for Amazon S3 to use in encrypting data. This value is used to store
Code Examples
key. The key must be appropriate for use with the algorithm specified in
the x-amz-server-side-encryption-customer-algorithm header. This must
User Guides be the same encryption key specified in the initiate multipart upload
(../../guide/index.html) request.
Available Services (index.html) Specifies the 128-bit MD5 digest of the encryption key according to RFC
ACM (acm.html) 1321. Amazon S3 uses this header for a message integrity check to
AlexaForBusiness
APIGateway
(apigateway.html)
ApiGatewayManagement parameter in their requests. Documentation on downloading objects
Api from requester pays buckets can be found at
(apigatewaymanagement http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
api.html) (http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
Return type
Boto 3 Docs 1.9.249
dict
documentation (
Returns
../../index.html)
Response Syntax
TABLE OF CONTENTS
{
Quickstart 'ServerSideEncryption': 'AES256'|'aws:kms',
(../../guide/quickstart.html) 'ETag': 'string',
A Sample Tutorial 'SSECustomerAlgorithm': 'string',
(../../guide/sqs.html) 'SSECustomerKeyMD5': 'string',
Code Examples
}
User Guides
Response Structure
(dict) --
ACM (acm.html)
AlexaForBusiness S3 (e.g., AES256, aws:kms).
ETag (string) --
Entity tag for the uploaded object.
APIGateway
(apigateway.html)
Api
api.html) SSECustomerKeyMD5 (string) --
Boto 3 Docs 1.9.249
documentation ( message integrity verification of the customer-provided encryption key.
../../index.html)
TABLE OF CONTENTS If present, specifies the ID of the AWS Key Management Service (KMS)
Quickstart RequestCharged (string) --
A Sample Tutorial request.
Code Examples
upload_part_copy (**kwargs)
Uploads a part by copying data from an existing object as data source.
User Guides
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPartCopy)
Request Syntax
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = client.upload_part_copy(
../../index.html) CopySource='string' or {'Bucket': 'string', 'Key': 'string', 'Vers
CopySourceIfMatch='string',
CopySourceIfModifiedSince=datetime(2015, 1, 1),
TABLE OF CONTENTS
CopySourceIfNoneMatch='string',
CopySourceIfUnmodifiedSince=datetime(2015, 1, 1),
Quickstart
CopySourceRange='string',
Key='string',
A Sample Tutorial PartNumber=123,
(../../guide/sqs.html) UploadId='string',
Code Examples SSECustomerAlgorithm='string',
(../../guide/examples.html) SSECustomerKey='string',
CopySourceSSECustomerAlgorithm='string',
User Guides
CopySourceSSECustomerKey='string',
ACM (acm.html)

AlexaForBusiness Bucket (string) -- [REQUIRED]
(alexaforbusiness.html) CopySource (str or dict) -- [REQUIRED] The name of the source bucket,
key name of the source object, and optional version ID of the source
APIGateway string form is {bucket}/{key} or {bucket}/{key}?versionId={versionId} if
(apigateway.html) you want to copy a specific version. You can also provide this value as a
Api
api.html)
may be omitted.
CopySourceIfMatch (string) -- Copies the object if its entity tag (ETag)
Boto 3 Docs 1.9.249
documentation ( CopySourceIfModifiedSince (datetime) -- Copies the object if it has been
../../index.html) modified since the specified time.
CopySourceIfNoneMatch (string) -- Copies the object if its entity tag
TABLE OF CONTENTS (ETag) is different than the specified ETag.
Quickstart been modified since the specified time.
(../../guide/quickstart.html) CopySourceRange (string) -- The range of bytes to copy from the source
object. The range value must use the form bytes=first-last, where the first
A Sample Tutorial and last are the zero-based byte offsets to copy. For example, bytes=0-9
(../../guide/sqs.html) indicates that you want to copy the first ten bytes of the source. You can
Code Examples copy a range only if the source object is greater than 5 MB.
(../../guide/examples.html) Key (string) -- [REQUIRED]
Part number of part being copied. This is a positive integer between 1
Available Services (index.html) and 10,000.
ACM (acm.html) UploadId (string) --

[REQUIRED]
Upload ID identifying the multipart upload whose part is being copied.
AlexaForBusiness
(alexaforbusiness.html) SSECustomerAlgorithm (string) -- Specifies the algorithm to use to when
APIGateway key for Amazon S3 to use in encrypting data. This value is used to store
(apigateway.html) the object and then it is discarded; Amazon does not store the encryption
Api
be the same encryption key specified in the initiate multipart upload
request.
api.html)
Boto 3 Docs 1.9.249
documentation ( 1321. Amazon S3 uses this header for a message integrity check to
../../index.html) ensure the encryption key was transmitted without error.
TABLE OF CONTENTS
Quickstart
A Sample Tutorial
use when decrypting the source object (e.g., AES256).
CopySourceSSECustomerKey (string) -- Specifies the customer-provided
Code Examples encryption key for Amazon S3 to use to decrypt the source object. The
(../../guide/examples.html) encryption key provided in this header must be one that was used when
User Guides
CopySourceSSECustomerKeyMD5 (string) --
Available Services (index.html) 1321. Amazon S3 uses this header for a message integrity check to
ACM (acm.html)
AlexaForBusiness provided. Including this parameter is not required
Amplify (amplify.html) RequestPayer (string) -- Confirms that the requester knows that she or
APIGateway he will be charged for the request. Bucket owners need not specify this
(apigateway.html) parameter in their requests. Documentation on downloading objects
Api
dict
Boto 3 Docs 1.9.249
TABLE OF CONTENTS {
Quickstart 'CopyPartResult': {
(../../guide/quickstart.html) 'ETag': 'string',
A Sample Tutorial 'LastModified': datetime(2015, 1, 1)
Code Examples
User Guides 'SSEKMSKeyId': 'string',
(../../guide/index.html) 'RequestCharged': 'requester'
}
ACM (acm.html)
Response Structure
(dict) --
AlexaForBusiness
CopySourceVersionId (string) --
The version of the source object that was copied, if you have enabled
versioning on the source bucket.
APIGateway
CopyPartResult (dict) --
(apigateway.html)
ETag (string) --
Api Entity tag of the object.
api.html)
Date and time at which the object was uploaded.
Boto 3 Docs 1.9.249
documentation ( ServerSideEncryption (string) --
../../index.html) The Server-side encryption algorithm used when storing this object in
TABLE OF CONTENTS SSECustomerAlgorithm (string) --

Quickstart
A Sample Tutorial
Code Examples
message integrity verification of the customer-provided encryption key.
User Guides SSEKMSKeyId (string) --
Available Services (index.html) master encryption key that was used for the object.
ACM (acm.html) RequestCharged (string) --
ACMPCA (acm-pca.html) If present, indicates that the requester was successfully charged for the
AlexaForBusiness request.
APIGateway Paginators
(apigateway.html)
ApiGatewayManagement The available paginators are:

Api
S3.Paginator.ListMultipartUploads
S3.Paginator.ListObjectVersions
api.html)
S3.Paginator.ListObjects
Boto 3 Docs 1.9.249
S3.Paginator.ListObjectsV2
documentation (
S3.Paginator.ListParts
../../index.html)
class S3.Paginator. ListMultipartUploads
TABLE OF CONTENTS
paginator = client.get_paginator('list_multipart_uploads')
Quickstart
paginate (**kwargs)
A Sample Tutorial
Creates an iterator that will paginate through responses from
S3.Client.list_multipart_uploads() .
Code Examples
User Guides 01/ListMultipartUploads)
Request Syntax
ACM (acm.html) response_iterator = paginator.paginate(

Bucket='string',
Delimiter='string',
AlexaForBusiness EncodingType='url',
(alexaforbusiness.html) Prefix='string',
PaginationConfig={
'MaxItems': 123,
APIGateway 'PageSize': 123,
(apigateway.html) 'StartingToken': 'string'
Api )
api.html)
Parameters
Boto 3 Docs 1.9.249
documentation ( Delimiter (string) -- Character you use to group keys.
../../index.html) EncodingType (string) -- Requests Amazon S3 to encode the object keys
TABLE OF CONTENTS may contain any Unicode character; however, XML 1.0 parser cannot
Quickstart 10. For characters that are not supported in XML 1.0, you can add this
(../../guide/quickstart.html) parameter to request that Amazon S3 encode the keys in the response.
Prefix (string) -- Lists in-progress uploads only for those keys that begin
A Sample Tutorial
with the specified prefix.
PaginationConfig (dict) --
Code Examples A dictionary that provides parameters to control pagination.
MaxItems (integer) --
User Guides The total number of items to return. If the total number of items
(../../guide/index.html) available is more than the value specified in max-items then a
NextToken will be provided in the output that you can use to resume
Available Services (index.html) pagination.
ACM (acm.html) PageSize (integer) --
ACMPCA (acm-pca.html) The size of each page.
AlexaForBusiness StartingToken (string) --

(alexaforbusiness.html) A token to specify where to start paginating. This is the NextToken from
a previous response.
Return type
APIGateway
dict
(apigateway.html)
Returns
Api Response Syntax
api.html)
Boto 3 Docs 1.9.249 {
'UploadIdMarker': 'string',
'Prefix': 'string',
TABLE OF CONTENTS
'MaxUploads': 123,
Quickstart
'IsTruncated': True|False,
'Uploads': [
A Sample Tutorial {
(../../guide/sqs.html) 'UploadId': 'string',
(../../guide/examples.html) 'Initiated': datetime(2015, 1, 1),
User Guides
'Owner': {
Available Services (index.html) 'ID': 'string'
},
ACM (acm.html)
'Initiator': {
ACMPCA (acm-pca.html) 'ID': 'string',
AlexaForBusiness
},
APIGateway 'CommonPrefixes': [
(apigateway.html) {
'Prefix': 'string'
},
Api
],
api.html) 'EncodingType': 'url',
'NextToken': 'string'
Boto 3 Docs 1.9.249
}
documentation (
../../index.html)
Response Structure
TABLE OF CONTENTS
(dict) --

Name of the bucket to which the multipart upload was initiated.
A Sample Tutorial
The key at or after which the listing began.
Code Examples
(../../guide/examples.html) UploadIdMarker (string) --
User Guides Upload ID after which listing began.

(../../guide/index.html) Prefix (string) --
Available Services (index.html) When a prefix is provided in the request, this field contains the
specified prefix. The result contains only keys starting with the
ACM (acm.html)
specified prefix.
AlexaForBusiness
MaxUploads (integer) --
Maximum number of multipart uploads that could have been included
in the response.
APIGateway
(apigateway.html)
Indicates whether the returned list of multipart uploads is truncated. A
value of true indicates that the list was truncated. The list can be
Api
truncated if the number of multipart uploads exceeds the limit allowed
or specified by max uploads.
api.html)
Uploads (list) --
Boto 3 Docs 1.9.249
../../index.html) UploadId (string) --

TABLE OF CONTENTS
Key (string) --
Quickstart Key of the object for which the multipart upload was initiated.
Initiated (datetime) --
A Sample Tutorial
Date and time at which the multipart upload was initiated.
Code Examples
(../../guide/examples.html) The class of storage used to store the object.
User Guides Owner (dict) --

(../../guide/index.html) DisplayName (string) --
ID (string) --
Initiator (dict) --
ACM (acm.html)
ID (string) --
AlexaForBusiness
If the principal is an AWS account, it provides the Canonical User
ID. If the principal is an IAM User, it provides a user ARN value.
APIGateway
(apigateway.html)
Api (dict) --
(apigatewaymanagement Prefix (string) --
api.html) EncodingType (string) --
Boto 3 Docs 1.9.249
response.
documentation (
NextToken (string) --
../../index.html)
A token to resume pagination.
TABLE OF CONTENTS
class S3.Paginator. ListObjectVersions

Quickstart
paginator = client.get_paginator('list_object_versions')
A Sample Tutorial
Code Examples paginate (**kwargs)

(../../guide/examples.html) Creates an iterator that will paginate through responses from
S3.Client.list_object_versions() .
User Guides
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectVersions)
Request Syntax
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response_iterator = paginator.paginate(
EncodingType='url',
Prefix='string',
TABLE OF CONTENTS
PaginationConfig={
'MaxItems': 123,
Quickstart
'PageSize': 123,
'StartingToken': 'string'
A Sample Tutorial }
Code Examples
Parameters
(../../guide/index.html) Delimiter (string) -- A delimiter is a character you use to group keys.
EncodingType (string) -- Requests Amazon S3 to encode the object keys
Available Services (index.html) in the response and specifies the encoding method to use. An object key
ACM (acm.html) may contain any Unicode character; however, XML 1.0 parser cannot
10. For characters that are not supported in XML 1.0, you can add this
AlexaForBusiness parameter to request that Amazon S3 encode the keys in the response.
(alexaforbusiness.html) Prefix (string) -- Limits the response to keys that begin with the specified
prefix.
APIGateway A dictionary that provides parameters to control pagination.
(apigateway.html)
ApiGatewayManagement The total number of items to return. If the total number of items
Api available is more than the value specified in max-items then a
(apigatewaymanagement NextToken will be provided in the output that you can use to resume
api.html) pagination.
PageSize (integer) --
Boto 3 Docs 1.9.249
The size of each page.
documentation (
StartingToken (string) --
../../index.html)
A token to specify where to start paginating. This is the NextToken from
TABLE OF CONTENTS
Return type
Quickstart dict
A Sample Tutorial Response Syntax
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
'VersionIdMarker': 'string',
'Versions': [
TABLE OF CONTENTS
{
'ETag': 'string',
Quickstart
'Size': 123,
'StorageClass': 'STANDARD',
A Sample Tutorial 'Key': 'string',
Code Examples 'IsLatest': True|False,
(../../guide/examples.html) 'LastModified': datetime(2015, 1, 1),
'Owner': {
User Guides
'ID': 'string'
},
ACM (acm.html)
],
ACMPCA (acm-pca.html) 'DeleteMarkers': [
{
AlexaForBusiness
(alexaforbusiness.html) 'Owner': {
Amplify (amplify.html) 'ID': 'string'
APIGateway },
(apigateway.html) 'Key': 'string',
'IsLatest': True|False,
Api
api.html) },
],
Boto 3 Docs 1.9.249
'Name': 'string',
documentation ( 'Prefix': 'string',
../../index.html) 'Delimiter': 'string',
'MaxKeys': 123,
TABLE OF CONTENTS 'CommonPrefixes': [
{
Quickstart 'Prefix': 'string'
],
A Sample Tutorial
'EncodingType': 'url',
Code Examples }

(dict) --
ACM (acm.html)
ACMPCA (acm-pca.html) results that satisfied the search criteria. If your results were truncated,
AlexaForBusiness
you can make a follow-up paginated request using the NextKeyMarker
and NextVersionIdMarker response parameters as a starting place in
another request to return the rest of the results.
APIGateway
(apigateway.html)
Marks the last Key returned in a truncated response.
VersionIdMarker (string) --
Api Versions (list) --
(dict) --
api.html)
ETag (string) --
Boto 3 Docs 1.9.249
documentation ( Size (integer) --
../../index.html) Size in bytes of the object.
TABLE OF CONTENTS

The object key.
A Sample Tutorial
Code Examples
(../../guide/examples.html) IsLatest (boolean) --
User Guides Specifies whether the object is (true) or is not (false) the latest
(../../guide/index.html) version of an object.
ACM (acm.html)
Owner (dict) --
AlexaForBusiness
ID (string) --
DeleteMarkers (list) --
(dict) --
APIGateway
Owner (dict) --
(apigateway.html)
ID (string) --
Api
Key (string) --
api.html) The object key.
Boto 3 Docs 1.9.249
documentation ( Version ID of an object.
../../index.html) IsLatest (boolean) --

Specifies whether the object is (true) or is not (false) the latest
TABLE OF CONTENTS version of an object.
Quickstart
(../../guide/quickstart.html) Date and time the object was last modified.
A Sample Tutorial Name (string) --

Prefix (string) --
Code Examples
MaxKeys (integer) --
User Guides
(../../guide/index.html) CommonPrefixes (list) --
(dict) --
Prefix (string) --
ACM (acm.html) EncodingType (string) --
ACMPCA (acm-pca.html) Encoding type used by Amazon S3 to encode object keys in the
response.
AlexaForBusiness
(alexaforbusiness.html) NextToken (string) --
Amplify (amplify.html) A token to resume pagination.
APIGateway
(apigateway.html)
class S3.Paginator. ListObjects
Api
paginator = client.get_paginator('list_objects')
api.html)
Boto 3 Docs 1.9.249 paginate (**kwargs)
documentation ( Creates an iterator that will paginate through responses from

S3.Client.list_objects() .
../../index.html)
TABLE OF CONTENTS (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjects)
Request Syntax
Quickstart
response_iterator = paginator.paginate(
(../../guide/sqs.html) Delimiter='string',
Code Examples EncodingType='url',
(../../guide/examples.html) Prefix='string',
User Guides PaginationConfig={
(../../guide/index.html) 'MaxItems': 123,
Available Services (index.html) 'PageSize': 123,
ACM (acm.html) }
AlexaForBusiness
Delimiter (string) -- A delimiter is a character you use to group keys.
APIGateway EncodingType (string) -- Requests Amazon S3 to encode the object keys
(apigateway.html) in the response and specifies the encoding method to use. An object key
ApiGatewayManagement may contain any Unicode character; however, XML 1.0 parser cannot
Api parse some characters, such as characters with an ASCII value from 0 to
(apigatewaymanagement 10. For characters that are not supported in XML 1.0, you can add this
api.html) parameter to request that Amazon S3 encode the keys in the response.
Boto 3 Docs 1.9.249
prefix.
../../index.html) he will be charged for the list objects request. Bucket owners need not
specify this parameter in their requests.
TABLE OF CONTENTS PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
Quickstart MaxItems (integer) --
(../../guide/quickstart.html) The total number of items to return. If the total number of items
A Sample Tutorial available is more than the value specified in max-items then a
(../../guide/sqs.html) NextToken will be provided in the output that you can use to resume
pagination.
Code Examples
(../../guide/examples.html) PageSize (integer) --
The size of each page.
User Guides
Available Services (index.html) a previous response.

dict
Returns
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
../../index.html) 'Marker': 'string',
'NextMarker': 'string',
'Contents': [
TABLE OF CONTENTS
{
'Key': 'string',
Quickstart
'ETag': 'string',
(../../guide/sqs.html) 'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'GLACI
Code Examples 'Owner': {
(../../guide/examples.html) 'DisplayName': 'string',
'ID': 'string'
User Guides
}
},
'Name': 'string',
ACM (acm.html)
'Prefix': 'string',
ACMPCA (acm-pca.html) 'Delimiter': 'string',
'MaxKeys': 123,
AlexaForBusiness
(alexaforbusiness.html) 'CommonPrefixes': [
{
Amplify (amplify.html) 'Prefix': 'string'
APIGateway },
'EncodingType': 'url',
Api
}
api.html)
Response Structure
Boto 3 Docs 1.9.249
../../index.html) IsTruncated (boolean) --

TABLE OF CONTENTS results that satisfied the search criteria.
Marker (string) --
Quickstart
(../../guide/quickstart.html) NextMarker (string) --
A Sample Tutorial When response is truncated (the IsTruncated element value in the
(../../guide/sqs.html) response is true), you can use the key name in this field as marker in
the subsequent request to get next set of objects. Amazon S3 lists
Code Examples
objects in alphabetical order Note: This element is returned only if you
have delimiter request parameter specified. If response does not
User Guides include the NextMaker and it is truncated, you can use the value of the
(../../guide/index.html) last Key in the response as the marker in the subsequent request to get
the next set of object keys.
Contents (list) --
ACM (acm.html)
(dict) --
Key (string) --
AlexaForBusiness
(alexaforbusiness.html) LastModified (datetime) --
Amplify (amplify.html) ETag (string) --
APIGateway Size (integer) --

Api
Owner (dict) --
api.html) DisplayName (string) --
ID (string) --
Boto 3 Docs 1.9.249
Name (string) --
documentation (
Prefix (string) --
../../index.html)
TABLE OF CONTENTS MaxKeys (integer) --
Quickstart
Prefix (string) --
A Sample Tutorial
Code Examples
response.
User Guides
(../../guide/index.html) A token to resume pagination.

class S3.Paginator. ListObjectsV2
ACM (acm.html)
paginator = client.get_paginator('list_objects_v2')
AlexaForBusiness
paginate (**kwargs)
APIGateway S3.Client.list_objects_v2() .
(apigateway.html)
ApiGatewayManagement (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsV2)
Api
api.html)
Boto 3 Docs 1.9.249 response_iterator = paginator.paginate(
EncodingType='url',
Prefix='string',
TABLE OF CONTENTS
FetchOwner=True|False,
StartAfter='string',
Quickstart
PaginationConfig={
A Sample Tutorial 'MaxItems': 123,
(../../guide/sqs.html) 'PageSize': 123,
Code Examples 'StartingToken': 'string'
)
User Guides
Parameters
Bucket (string) --
ACMPCA (acm-pca.html) Name of the bucket to list.
AlexaForBusiness Delimiter (string) -- A delimiter is a character you use to group keys.

(alexaforbusiness.html) EncodingType (string) -- Encoding type used by Amazon S3 to encode
object keys in the response.
APIGateway prefix.
(apigateway.html) FetchOwner (boolean) -- The owner field is not present in listV2 by
default, if you want to return owner field with each key in the result then
set the fetch owner field to true
Api
StartAfter (string) -- StartAfter is where you want Amazon S3 to start
listing from. Amazon S3 starts listing after this specified key. StartAfter
api.html)
can be any key in the bucket
Boto 3 Docs 1.9.249
documentation ( he will be charged for the list objects request in V2 style. Bucket owners
../../index.html) need not specify this parameter in their requests.
TABLE OF CONTENTS A dictionary that provides parameters to control pagination.
Quickstart The total number of items to return. If the total number of items
(../../guide/quickstart.html) available is more than the value specified in max-items then a
A Sample Tutorial NextToken will be provided in the output that you can use to resume
(../../guide/sqs.html) pagination.
Code Examples PageSize (integer) --

(../../guide/examples.html) The size of each page.
User Guides
Return type
ACM (acm.html) dict
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
../../index.html) 'Contents': [
{
'Key': 'string',
TABLE OF CONTENTS
'ETag': 'string',
Quickstart
'Size': 123,
'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'GLACI
A Sample Tutorial 'Owner': {
Code Examples 'ID': 'string'
},
User Guides
],
'Name': 'string',
ACM (acm.html)
'MaxKeys': 123,
ACMPCA (acm-pca.html) 'CommonPrefixes': [
{
AlexaForBusiness
},
APIGateway 'EncodingType': 'url',
(apigateway.html) 'KeyCount': 123,
'ContinuationToken': 'string',
'StartAfter': 'string',
Api
api.html) }
Boto 3 Docs 1.9.249
TABLE OF CONTENTS
Quickstart results that satisfied the search criteria.
(../../guide/quickstart.html) Contents (list) --
A Sample Tutorial Metadata about each object returned.
(dict) --
Code Examples
User Guides
(../../guide/index.html) ETag (string) --
Available Services (index.html) Size (integer) --
AlexaForBusiness Owner (dict) --

Name (string) --
APIGateway
(apigateway.html) Name of the bucket to list.

Api Limits the response to keys that begin with the specified prefix.
api.html) Delimiter (string) --
A delimiter is a character you use to group keys.
Boto 3 Docs 1.9.249
documentation ( MaxKeys (integer) --
../../index.html) Sets the maximum number of keys returned in the response. The
response might contain fewer keys but will never contain more.
CommonPrefixes contains all (if there are any) keys between Prefix and
Quickstart
the next occurrence of the string specified by delimiter
(dict) --
A Sample Tutorial
Prefix (string) --
Code Examples
response.
User Guides KeyCount (integer) --
KeyCount is the number of keys returned with this request. KeyCount
Available Services (index.html) will always be less than equals to MaxKeys field. Say you ask for 50
ACM (acm.html) keys, your result will include less than equals 50 keys
ACMPCA (acm-pca.html) ContinuationToken (string) --
AlexaForBusiness ContinuationToken indicates Amazon S3 that the list is being continued

(alexaforbusiness.html) on this bucket with a token. ContinuationToken is obfuscated and is
not a real key
StartAfter (string) --
APIGateway
(apigateway.html) StartAfter is where you want Amazon S3 to start listing from. Amazon
S3 starts listing after this specified key. StartAfter can be any key in the
ApiGatewayManagement bucket
Api
(apigatewaymanagement NextToken (string) --
api.html) A token to resume pagination.
Boto 3 Docs 1.9.249
documentation ( class S3.Paginator. ListParts
../../index.html)
paginator = client.get_paginator('list_parts')
TABLE OF CONTENTS
paginate (**kwargs)
Quickstart
S3.Client.list_parts() .
A Sample Tutorial
Code Examples
User Guides
response_iterator = paginator.paginate(
Bucket='string',
Available Services (index.html) Key='string',
UploadId='string',
ACM (acm.html)
ACMPCA (acm-pca.html) PaginationConfig={
AlexaForBusiness 'MaxItems': 123,
(alexaforbusiness.html) 'PageSize': 123,
}
APIGateway )
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249
[REQUIRED]
documentation (
Upload ID identifying the multipart upload whose parts are being listed.
../../index.html)
TABLE OF CONTENTS he will be charged for the request. Bucket owners need not specify this
Quickstart
A Sample Tutorial PaginationConfig (dict) --
(../../guide/sqs.html) A dictionary that provides parameters to control pagination.
Code Examples MaxItems (integer) --
(../../guide/examples.html) The total number of items to return. If the total number of items
available is more than the value specified in max-items then a
User Guides
NextToken will be provided in the output that you can use to resume
pagination.
PageSize (integer) --
ACM (acm.html) The size of each page.
ACMPCA (acm-pca.html) StartingToken (string) --

AlexaForBusiness
Return type
dict
APIGateway
Returns
(apigateway.html)
Response Syntax
Api
api.html)
Boto 3 Docs 1.9.249 {
'Bucket': 'string',
'Key': 'string',
TABLE OF CONTENTS
'PartNumberMarker': 123,
Quickstart
'MaxParts': 123,
'IsTruncated': True|False,
A Sample Tutorial 'Parts': [
(../../guide/sqs.html) {
Code Examples 'PartNumber': 123,
(../../guide/examples.html) 'LastModified': datetime(2015, 1, 1),
'ETag': 'string',
User Guides
'Size': 123
},
'Initiator': {
ACM (acm.html)
'ID': 'string',
ACMPCA (acm-pca.html) 'DisplayName': 'string'
},
AlexaForBusiness
(alexaforbusiness.html) 'Owner': {
Amplify (amplify.html) 'ID': 'string'
APIGateway },
(apigateway.html) 'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|
Api
}
api.html)
Response Structure
Boto 3 Docs 1.9.249
../../index.html) AbortDate (datetime) --
Date when multipart upload will become eligible for abort operation by
TABLE OF CONTENTS lifecycle.
AbortRuleId (string) --
Quickstart
(../../guide/quickstart.html) Id of the lifecycle rule that makes a multipart upload eligible for abort
operation.
A Sample Tutorial
(../../guide/sqs.html) Bucket (string) --
Key (string) --
User Guides Object key for which the multipart upload was initiated.
Upload ID identifying the multipart upload whose parts are being
ACM (acm.html) listed.
ACMPCA (acm-pca.html) PartNumberMarker (integer) --
AlexaForBusiness Part number after which listing begins.
MaxParts (integer) --
Maximum number of parts that were allowed in the response.
APIGateway
(apigateway.html)
Indicates whether the returned list of parts is truncated.
Api Parts (list) --
(dict) --
api.html)
Boto 3 Docs 1.9.249
documentation ( Part number identifying the part. This is a positive integer between
1 and 10,000.
../../index.html)
TABLE OF CONTENTS Date and time at which the part was uploaded.
ETag (string) --
Quickstart
(../../guide/quickstart.html) Entity tag returned when the part was uploaded.
A Sample Tutorial Size (integer) --

Size in bytes of the uploaded part data.
Code Examples
Initiator (dict) --
User Guides
(../../guide/index.html) ID (string) --
If the principal is an AWS account, it provides the Canonical User ID. If
the principal is an IAM User, it provides a user ARN value.
ACM (acm.html)
AlexaForBusiness
Owner (dict) --
ID (string) --
APIGateway StorageClass (string) --
(apigateway.html)
Api
api.html) request.
Boto 3 Docs 1.9.249
documentation ( A token to resume pagination.
../../index.html)
TABLE OF CONTENTS
Waiters
Quickstart
(../../guide/quickstart.html) The available waiters are:
A Sample Tutorial S3.Waiter.BucketExists

(../../guide/sqs.html) S3.Waiter.BucketNotExists
S3.Waiter.ObjectExists
Code Examples
(../../guide/examples.html) S3.Waiter.ObjectNotExists
class S3.Waiter. BucketExists

User Guides
waiter = client.get_waiter('bucket_exists')
ACM (acm.html)
wait (**kwargs)
Polls S3.Client.head_bucket() every 5 seconds until a successful state is
AlexaForBusiness reached. An error is returned after 20 failed checks.
Amplify (amplify.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadBucket)
APIGateway Request Syntax
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 waiter.wait(
../../index.html) WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
TABLE OF CONTENTS
}
)
Quickstart

WaiterConfig (dict) --
Code Examples
A dictionary that provides parameters to control waiting behavior.
Delay (integer) --
User Guides The amount of time in seconds to wait between attempts. Default: 5
MaxAttempts (integer) --
Available Services (index.html) The maximum number of attempts to be made. Default: 20
ACMPCA (acm-pca.html) None
AlexaForBusiness
(alexaforbusiness.html) class S3.Waiter. BucketNotExists
APIGateway waiter = client.get_waiter('bucket_not_exists')

(apigateway.html)
ApiGatewayManagement wait (**kwargs)

Api Polls S3.Client.head_bucket() every 5 seconds until a successful state is
reached. An error is returned after 20 failed checks.
api.html)
Boto 3 Docs 1.9.249
documentation (
Request Syntax
../../index.html)
TABLE OF CONTENTS waiter.wait(

Bucket='string',
Quickstart WaiterConfig={
(../../guide/quickstart.html) 'Delay': 123,
'MaxAttempts': 123
A Sample Tutorial
}
)
Code Examples
Parameters
(../../guide/index.html) WaiterConfig (dict) --
A dictionary that provides parameters to control waiting behavior.
Delay (integer) --
ACM (acm.html)
The amount of time in seconds to wait between attempts. Default: 5
AlexaForBusiness The maximum number of attempts to be made. Default: 20
Returns
APIGateway
(apigateway.html)
class S3.Waiter. ObjectExists
Api
(apigatewaymanagement waiter = client.get_waiter('object_exists')
api.html)
Boto 3 Docs 1.9.249 wait (**kwargs)
Polls S3.Client.head_object() every 5 seconds until a successful state is
documentation (
reached. An error is returned after 20 failed checks.
../../index.html)
TABLE OF CONTENTS
Request Syntax
Quickstart
waiter.wait(
(../../guide/sqs.html) IfMatch='string',
Code Examples IfModifiedSince=datetime(2015, 1, 1),
(../../guide/examples.html) IfNoneMatch='string',
User Guides Key='string',
(../../guide/index.html) Range='string',
Available Services (index.html) VersionId='string',

ACM (acm.html) SSECustomerKey='string',
PartNumber=123,
AlexaForBusiness
WaiterConfig={
'Delay': 123,
Amplify (amplify.html) 'MaxAttempts': 123
APIGateway }
(apigateway.html) )
Api Parameters
(apigatewaymanagement Bucket (string) -- [REQUIRED]
api.html)
Boto 3 Docs 1.9.249
documentation ( IfModifiedSince (datetime) -- Return the object only if it has been
../../index.html) modified since the specified time, otherwise return a 304 (not modified).
TABLE OF CONTENTS different from the one specified, otherwise return a 304 (not modified).
Quickstart modified since the specified time, otherwise return a 412 (precondition
(../../guide/quickstart.html) failed).
A Sample Tutorial Range (string) -- Downloads the specified range bytes of an object. For
(../../guide/sqs.html) more information about the HTTP Range header, go to
Code Examples http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
(../../guide/examples.html) (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35).
User Guides object.
(../../guide/index.html) SSECustomerAlgorithm (string) -- Specifies the algorithm to use to when
ACM (acm.html) key for Amazon S3 to use in encrypting data. This value is used to store
AlexaForBusiness the x-amz-server-side-encryption-customer-algorithm header.
(alexaforbusiness.html) SSECustomerKeyMD5 (string) --
Amplify (amplify.html) Specifies the 128-bit MD5 digest of the encryption key according to RFC
APIGateway ensure the encryption key was transmitted without error.
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249
Quickstart positive integer between 1 and 10,000. Effectively performs a 'ranged'
(../../guide/quickstart.html) HEAD request for the part specified. Useful querying about the size of the
A Sample Tutorial WaiterConfig (dict) --
(../../guide/sqs.html) A dictionary that provides parameters to control waiting behavior.
Code Examples Delay (integer) --
(../../guide/examples.html) The amount of time in seconds to wait between attempts. Default: 5
User Guides MaxAttempts (integer) --
(../../guide/index.html) The maximum number of attempts to be made. Default: 20

None
ACM (acm.html)
class S3.Waiter. ObjectNotExists
AlexaForBusiness
waiter = client.get_waiter('object_not_exists')
APIGateway
(apigateway.html) wait (**kwargs)
ApiGatewayManagement Polls S3.Client.head_object() every 5 seconds until a successful state is

Api reached. An error is returned after 20 failed checks.
(apigatewaymanagement See also: AWS API Documentation
api.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadObject)
Request Syntax
Boto 3 Docs 1.9.249
documentation (
waiter.wait(
../../index.html)
Bucket='string',
IfMatch='string',
TABLE OF CONTENTS
Quickstart
Key='string',
A Sample Tutorial Range='string',
(../../guide/sqs.html) VersionId='string',
Code Examples SSECustomerAlgorithm='string',

(../../guide/examples.html) SSECustomerKey='string',
User Guides PartNumber=123,
(../../guide/index.html) WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
ACM (acm.html) }
AlexaForBusiness
APIGateway as the one specified, otherwise return a 412 (precondition failed).
(apigateway.html) IfModifiedSince (datetime) -- Return the object only if it has been
ApiGatewayManagement modified since the specified time, otherwise return a 304 (not modified).
Api IfNoneMatch (string) -- Return the object only if its entity tag (ETag) is
(apigatewaymanagement different from the one specified, otherwise return a 304 (not modified).
api.html)
Boto 3 Docs 1.9.249
../../index.html) Key (string) -- [REQUIRED]
TABLE OF CONTENTS more information about the HTTP Range header, go to
Quickstart (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35).
(../../guide/quickstart.html) VersionId (string) -- VersionId used to reference a specific version of the
object.
A Sample Tutorial SSECustomerAlgorithm (string) -- Specifies the algorithm to use to when
(../../guide/sqs.html) encrypting the object (e.g., AES256).
Code Examples SSECustomerKey (string) -- Specifies the customer-provided encryption
(../../guide/examples.html) key for Amazon S3 to use in encrypting data. This value is used to store
User Guides key. The key must be appropriate for use with the algorithm specified in
(../../guide/index.html) the x-amz-server-side-encryption-customer-algorithm header.
ACM (acm.html) 1321. Amazon S3 uses this header for a message integrity check to
AlexaForBusiness
(alexaforbusiness.html) Please note that this parameter is automatically populated if it is not
APIGateway
(apigateway.html)
ApiGatewayManagement parameter in their requests. Documentation on downloading objects
Api from requester pays buckets can be found at
(apigatewaymanagement http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
api.html) (http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
Boto 3 Docs 1.9.249
documentation ( HEAD request for the part specified. Useful querying about the size of the
../../index.html) part and the number of parts in this object.
WaiterConfig (dict) --
TABLE OF CONTENTS A dictionary that provides parameters to control waiting behavior.
Delay (integer) --
Quickstart The amount of time in seconds to wait between attempts. Default: 5
A Sample Tutorial The maximum number of attempts to be made. Default: 20
Returns
Code Examples None
User Guides

Service Resource
ACM (acm.html) class S3. ServiceResource
ACMPCA (acm-pca.html) A resource representing Amazon Simple Storage Service (S3):
AlexaForBusiness
(alexaforbusiness.html) import boto3
APIGateway
(apigateway.html)
These are the resource's available actions:
Api create_bucket()
(apigatewaymanagement get_available_subresources()
api.html) These are the resource's available sub-resources:
Bucket()
Boto 3 Docs 1.9.249
BucketAcl()
documentation ( BucketCors()
../../index.html) BucketLifecycle()
BucketLifecycleConfiguration()
TABLE OF CONTENTS BucketLogging()
BucketNotification()
Quickstart BucketPolicy()
(../../guide/quickstart.html) BucketRequestPayment()
BucketTagging()
A Sample Tutorial
(../../guide/sqs.html) BucketVersioning()
BucketWebsite()
Code Examples MultipartUpload()
MultipartUploadPart()
User Guides Object()
(../../guide/index.html) ObjectAcl()
ObjectSummary()
Available Services (index.html) ObjectVersion()
ACM (acm.html) These are the resource's available collections:
ACMPCA (acm-pca.html) buckets
AlexaForBusiness Actions
Actions call operations on resources. They may automatically handle the passing in
Amplify (amplify.html) of arguments set from identifiers and some attributes. For more information about
actions refer to the Resources Introduction Guide
APIGateway
(../../guide/resources.html#actions-intro).
(apigateway.html)
ApiGatewayManagement create_bucket (**kwargs)

Api Creates a new bucket.
api.html)
Request Syntax
Boto 3 Docs 1.9.249
documentation (
bucket = s3.create_bucket(
../../index.html)
ACL='private'|'public-read'|'public-read-write'|'authenticated-rea
Bucket='string',
TABLE OF CONTENTS
CreateBucketConfiguration={
'LocationConstraint': 'EU'|'eu-west-1'|'us-west-1'|'us-west-2'
Quickstart
},
A Sample Tutorial GrantRead='string',
(../../guide/sqs.html) GrantReadACP='string',
Code Examples GrantWrite='string',

(../../guide/examples.html) GrantWriteACP='string',
ObjectLockEnabledForBucket=True|False
User Guides )

Parameters
ACM (acm.html)
ACMPCA (acm-pca.html) Bucket (string) -- [REQUIRED]
AlexaForBusiness CreateBucketConfiguration (dict) --
(alexaforbusiness.html) LocationConstraint (string) --
Specifies the region where the bucket will be created. If you don't
Amplify (amplify.html) specify a region, the bucket is created in US East (N. Virginia) Region
APIGateway (us-east-1).
(apigateway.html) GrantFullControl (string) -- Allows grantee the read, write, read ACP, and
ApiGatewayManagement write ACP permissions on the bucket.
Api GrantRead (string) -- Allows grantee to list the objects in the bucket.
(apigatewaymanagement GrantReadACP (string) -- Allows grantee to read the bucket ACL.
api.html)
Boto 3 Docs 1.9.249
object in the bucket.
documentation ( GrantWriteACP (string) -- Allows grantee to write the ACL for the
../../index.html) applicable bucket.
ObjectLockEnabledForBucket (boolean) -- Specifies whether you want
TABLE OF CONTENTS Amazon S3 object lock to be enabled for the new bucket.
Return type
Quickstart s3.Bucket
Returns
A Sample Tutorial
Bucket resource
Code Examples
(../../guide/examples.html) get_available_subresources ()
Returns a list of all the available sub-resources for this Resource.
User Guides
A list containing the name of each sub-resource for this resource
Return type
ACM (acm.html)
list of str
AlexaForBusiness
Sub-resources
Sub-resources are methods that create a new instance of a child resource. This
Amplify (amplify.html) resource's identifiers get passed along to the child. For more information about
APIGateway sub-resources refer to the Resources Introduction Guide
(apigateway.html) (../../guide/resources.html#subresources-intro).
ApiGatewayManagement Bucket (name)

Api Creates a Bucket resource.:
api.html)
Boto 3 Docs 1.9.249 bucket = s3.Bucket('name')
documentation (
../../index.html) Parameters
name (string) -- The Bucket's name identifier. This must be set.
TABLE OF CONTENTS
Return type
S3.Bucket
Quickstart
A Sample Tutorial A Bucket resource
Code Examples
BucketAcl (bucket_name)
Creates a BucketAcl resource.:
User Guides
bucket_acl = s3.BucketAcl('bucket_name')
ACM (acm.html) Parameters

ACMPCA (acm-pca.html) bucket_name (string) -- The BucketAcl's bucket_name identifier. This must
be set.
AlexaForBusiness
(alexaforbusiness.html) Return type
S3.BucketAcl
Returns
APIGateway
A BucketAcl resource
(apigateway.html)
Api BucketCors (bucket_name)
(apigatewaymanagement Creates a BucketCors resource.:
api.html)
Boto 3 Docs 1.9.249 bucket_cors = s3.BucketCors('bucket_name')
documentation (
../../index.html) Parameters
bucket_name (string) -- The BucketCors's bucket_name identifier. This
TABLE OF CONTENTS must be set.
Return type
Quickstart
S3.BucketCors

(../../guide/sqs.html) A BucketCors resource
Code Examples
BucketLifecycle (bucket_name)
User Guides Creates a BucketLifecycle resource.:
Available Services (index.html) bucket_lifecycle = s3.BucketLifecycle('bucket_name')
ACM (acm.html)
Parameters
bucket_name (string) -- The BucketLifecycle's bucket_name identifier. This
AlexaForBusiness must be set.
Return type
S3.BucketLifecycle
APIGateway
Returns
(apigateway.html)
A BucketLifecycle resource
Api
(apigatewaymanagement BucketLifecycleConfiguration (bucket_name)
api.html) Creates a BucketLifecycleConfiguration resource.:
Boto 3 Docs 1.9.249 bucket_lifecycle_configuration = s3.BucketLifecycleConfiguration('buck
documentation (
../../index.html)
Parameters
TABLE OF CONTENTS bucket_name (string) -- The BucketLifecycleConfiguration's bucket_name
identifier. This must be set.
S3.BucketLifecycleConfiguration
A Sample Tutorial
Returns
A BucketLifecycleConfiguration resource
Code Examples
BucketLogging (bucket_name)
User Guides
(../../guide/index.html) Creates a BucketLogging resource.:

bucket_logging = s3.BucketLogging('bucket_name')
ACM (acm.html)

AlexaForBusiness bucket_name (string) -- The BucketLogging's bucket_name identifier. This
(alexaforbusiness.html) must be set.
APIGateway S3.BucketLogging
ApiGatewayManagement A BucketLogging resource
Api
api.html) BucketNotification (bucket_name)
Creates a BucketNotification resource.:
Boto 3 Docs 1.9.249
documentation (
bucket_notification = s3.BucketNotification('bucket_name')
../../index.html)

bucket_name (string) -- The BucketNotification's bucket_name identifier.
Quickstart This must be set.
Return type
A Sample Tutorial S3.BucketNotification
Returns
Code Examples A BucketNotification resource
User Guides
(../../guide/index.html) BucketPolicy (bucket_name)
Creates a BucketPolicy resource.:
ACM (acm.html) bucket_policy = s3.BucketPolicy('bucket_name')

(alexaforbusiness.html) bucket_name (string) -- The BucketPolicy's bucket_name identifier. This
Amplify (amplify.html) must be set.
APIGateway Return type

(apigateway.html) S3.BucketPolicy
Api A BucketPolicy resource
api.html)
Boto 3 Docs 1.9.249 BucketRequestPayment (bucket_name)
Creates a BucketRequestPayment resource.:
documentation (
../../index.html)
bucket_request_payment = s3.BucketRequestPayment('bucket_name')
TABLE OF CONTENTS
Parameters
Quickstart bucket_name (string) -- The BucketRequestPayment's bucket_name
(../../guide/quickstart.html) identifier. This must be set.
S3.BucketRequestPayment
Code Examples
Returns
A BucketRequestPayment resource
User Guides
BucketTagging (bucket_name)
Creates a BucketTagging resource.:
ACM (acm.html)
ACMPCA (acm-pca.html) bucket_tagging = s3.BucketTagging('bucket_name')

AlexaForBusiness
Parameters
Amplify (amplify.html) bucket_name (string) -- The BucketTagging's bucket_name identifier. This
must be set.
APIGateway
(apigateway.html) Return type
ApiGatewayManagement S3.BucketTagging
Api Returns
A BucketTagging resource
api.html)
Boto 3 Docs 1.9.249 BucketVersioning (bucket_name)
Creates a BucketVersioning resource.:
documentation (
../../index.html)
bucket_versioning = s3.BucketVersioning('bucket_name')
TABLE OF CONTENTS
Parameters
Quickstart bucket_name (string) -- The BucketVersioning's bucket_name identifier.
(../../guide/quickstart.html) This must be set.
S3.BucketVersioning
Code Examples
Returns
A BucketVersioning resource
User Guides
BucketWebsite (bucket_name)
Creates a BucketWebsite resource.:
ACM (acm.html)
ACMPCA (acm-pca.html) bucket_website = s3.BucketWebsite('bucket_name')

AlexaForBusiness
Parameters
Amplify (amplify.html) bucket_name (string) -- The BucketWebsite's bucket_name identifier. This
must be set.
APIGateway
ApiGatewayManagement S3.BucketWebsite
Api Returns
A BucketWebsite resource
api.html)
Boto 3 Docs 1.9.249 MultipartUpload (bucket_name, object_key, id)
documentation ( Creates a MultipartUpload resource.:
../../index.html)
multipart_upload = s3.MultipartUpload('bucket_name','object_key','id')
TABLE OF CONTENTS
(../../guide/quickstart.html) bucket_name (string) -- The MultipartUpload's bucket_name identifier.
A Sample Tutorial
This must be set.
object_key (string) -- The MultipartUpload's object_key identifier. This
must be set.
Code Examples id (string) -- The MultipartUpload's id identifier. This must be set.
Return type
User Guides S3.MultipartUpload
Returns
Available Services (index.html) A MultipartUpload resource
ACM (acm.html)
ACMPCA (acm-pca.html) MultipartUploadPart (bucket_name, object_key, multipart_upload_id,

AlexaForBusiness part_number)
(alexaforbusiness.html) Creates a MultipartUploadPart resource.:
APIGateway multipart_upload_part = s3.MultipartUploadPart('bucket_name','object_k

(apigateway.html)
Api Parameters
(apigatewaymanagement bucket_name (string) -- The MultipartUploadPart's bucket_name
api.html) identifier. This must be set.
object_key (string) -- The MultipartUploadPart's object_key identifier. This
Boto 3 Docs 1.9.249
must be set.
documentation ( multipart_upload_id (string) -- The MultipartUploadPart's
../../index.html) multipart_upload_id identifier. This must be set.
part_number (string) -- The MultipartUploadPart's part_number
TABLE OF CONTENTS identifier. This must be set.
Return type
Quickstart S3.MultipartUploadPart
Returns
A Sample Tutorial
A MultipartUploadPart resource
Code Examples
(../../guide/examples.html) Object (bucket_name, key)
Creates a Object resource.:
User Guides
object = s3.Object('bucket_name','key')
ACM (acm.html)
Parameters
ACMPCA (acm-pca.html) bucket_name (string) -- The Object's bucket_name identifier. This must
AlexaForBusiness be set.
(alexaforbusiness.html) key (string) -- The Object's key identifier. This must be set.

S3.Object
APIGateway
ApiGatewayManagement A Object resource
Api
api.html) ObjectAcl (bucket_name, object_key)
Creates a ObjectAcl resource.:
Boto 3 Docs 1.9.249
documentation (
object_acl = s3.ObjectAcl('bucket_name','object_key')
../../index.html)

bucket_name (string) -- The ObjectAcl's bucket_name identifier. This
Quickstart must be set.
(../../guide/quickstart.html) object_key (string) -- The ObjectAcl's object_key identifier. This must be
set.
A Sample Tutorial
(../../guide/sqs.html) Return type
S3.ObjectAcl
Code Examples
A ObjectAcl resource
User Guides
Available Services (index.html) ObjectSummary (bucket_name, key)
ACM (acm.html) Creates a ObjectSummary resource.:
object_summary = s3.ObjectSummary('bucket_name','key')
AlexaForBusiness
Parameters
bucket_name (string) -- The ObjectSummary's bucket_name identifier.
APIGateway This must be set.
(apigateway.html) key (string) -- The ObjectSummary's key identifier. This must be set.
Api
S3.ObjectSummary
api.html) Returns
A ObjectSummary resource
Boto 3 Docs 1.9.249
documentation (
../../index.html) ObjectVersion (bucket_name, object_key, id)
Creates a ObjectVersion resource.:
TABLE OF CONTENTS
object_version = s3.ObjectVersion('bucket_name','object_key','id')
Quickstart
Parameters
A Sample Tutorial
(../../guide/sqs.html) bucket_name (string) -- The ObjectVersion's bucket_name identifier. This
must be set.
Code Examples object_key (string) -- The ObjectVersion's object_key identifier. This must
(../../guide/examples.html) be set.
User Guides
id (string) -- The ObjectVersion's id identifier. This must be set.
S3.ObjectVersion
ACM (acm.html)
Returns
A ObjectVersion resource
AlexaForBusiness
(alexaforbusiness.html) Collections
Collections provide an interface to iterate over and manipulate groups of resources.
For more information about collections refer to the Resources Introduction Guide
APIGateway (../../guide/collections.html#guide-collections).
(apigateway.html)
buckets
ApiGatewayManagement A collection of Bucket resources
Api
(apigatewaymanagement all ()
api.html) Creates an iterable of all Bucket resources in the collection.
Boto 3 Docs 1.9.249
documentation (
Request Syntax
../../index.html)
TABLE OF CONTENTS bucket_iterator = s3.buckets.all()

list( s3.Bucket )
A Sample Tutorial
Returns
A list of Bucket resources
Code Examples
filter ()
User Guides
(../../guide/index.html) Creates an iterable of all Bucket resources in the collection filtered by
kwargs passed to method.
ACM (acm.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBuckets)
ACMPCA (acm-pca.html) Request Syntax
AlexaForBusiness
(alexaforbusiness.html) bucket_iterator = s3.buckets.filter()

(apigateway.html) list( s3.Bucket )
Api A list of Bucket resources
api.html)
Boto 3 Docs 1.9.249 limit (**kwargs)
Creates an iterable up to a specified amount of Bucket resources in the
documentation (
collection.
../../index.html)
TABLE OF CONTENTS
Request Syntax
Quickstart
bucket_iterator = s3.buckets.limit()
A Sample Tutorial
Return type
Code Examples list( s3.Bucket )
Returns
User Guides A list of Bucket resources

page_size (**kwargs)
ACM (acm.html)
Creates an iterable of all Bucket resources in the collection, but limits the
ACMPCA (acm-pca.html) number of items returned by each service call by the specified amount.

(alexaforbusiness.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBuckets)
APIGateway
(apigateway.html) bucket_iterator = s3.buckets.page_size()
Api Return type
list( s3.Bucket )
api.html)
Returns
Boto 3 Docs 1.9.249
A list of Bucket resources
documentation (
../../index.html)
TABLE OF CONTENTS Bucket

Quickstart
class S3. Bucket (name)
A resource representing an Amazon Simple Storage Service (S3) Bucket:
A Sample Tutorial
import boto3
Code Examples
User Guides bucket = s3.Bucket('name')

name (string) -- The Bucket's name identifier. This must be set.
ACM (acm.html)
ACMPCA (acm-pca.html) These are the resource's available identifiers:
AlexaForBusiness name
These are the resource's available attributes:
creation_date
APIGateway
(apigateway.html)
copy()
create()
Api
delete()
api.html) delete_objects()
download_file()
Boto 3 Docs 1.9.249
download_fileobj()
documentation ( get_available_subresources()
../../index.html) load()
put_object()
TABLE OF CONTENTS upload_file()
upload_fileobj()
Quickstart
These are the resource's available sub-resources:
Acl()
A Sample Tutorial
Cors()
Lifecycle()
Code Examples LifecycleConfiguration()
(../../guide/examples.html) Logging()
Notification()
User Guides
Object()
Policy()
Available Services (index.html) RequestPayment()
ACM (acm.html) Tagging()
Versioning()
ACMPCA (acm-pca.html) Website()
AlexaForBusiness
These are the resource's available collections:
multipart_uploads
object_versions
APIGateway objects
(apigateway.html)
These are the resource's available waiters:
wait_until_exists()
Api
wait_until_not_exists()
api.html) Identifiers
Identifiers are properties of a resource that are set upon instantation of the
Boto 3 Docs 1.9.249
resource. For more information about identifiers refer to the Resources
documentation ( Introduction Guide (../../guide/resources.html#identifiers-attributes-intro).
../../index.html)
name
(string) The Bucket's name identifier. This must be set.
TABLE OF CONTENTS
Attributes
Quickstart Attributes provide access to the properties of a resource. Attributes are lazy-loaded
(../../guide/quickstart.html) the first time one is accessed via the load() method. For more information about
A Sample Tutorial attributes refer to the Resources Introduction Guide
(../../guide/sqs.html) (../../guide/resources.html#identifiers-attributes-intro).
Code Examples creation_date

(../../guide/examples.html) (datetime) --
User Guides Date the bucket was created.

Actions
Available Services (index.html) Actions call operations on resources. They may automatically handle the passing in
ACM (acm.html) of arguments set from identifiers and some attributes. For more information about
AlexaForBusiness
copy (CopySource, Key, ExtraArgs=None, Callback=None, SourceClient=None,
Config=None)
Copy an object from one S3 location to an object in this bucket.
APIGateway
This is a managed transfer which will perform a multipart copy in multiple
(apigateway.html)
Usage:
Api
api.html)
Boto 3 Docs 1.9.249 import boto3
documentation ( s3 = boto3.resource('s3')
../../index.html) copy_source = {
'Bucket': 'mybucket',
'Key': 'mykey'
TABLE OF CONTENTS
}
bucket = s3.Bucket('otherbucket')
Quickstart
bucket.copy(copy_source, 'otherkey')
A Sample Tutorial
CopySource (dict) -- The name of the source bucket, key name of the
Code Examples
source object, and optional version ID of the source object. The dictionary
format is: {'Bucket': 'bucket', 'Key': 'key', 'VersionId': 'id'} .
User Guides Note that the VersionId key is optional and may be omitted.
(../../guide/index.html) Key (str) -- The name of the key to copy to
Available Services (index.html) operation
ACM (acm.html) Callback (function) -- A method which takes a number of bytes
transferred to be periodically called during the copy.
AlexaForBusiness operation that may happen at the source object. For example, this client
(alexaforbusiness.html) is used for the head_object that determines the size of the copy. If no
client is provided, the current client is used as the client for the source
object.
Api
create (**kwargs)
api.html)
Creates a new bucket.
Boto 3 Docs 1.9.249
../../index.html)
Request Syntax
TABLE OF CONTENTS
response = bucket.create(
Quickstart ACL='private'|'public-read'|'public-read-write'|'authenticated-rea
(../../guide/quickstart.html) CreateBucketConfiguration={
A Sample Tutorial 'LocationConstraint': 'EU'|'eu-west-1'|'us-west-1'|'us-west-2'
Code Examples
GrantRead='string',
User Guides GrantWrite='string',
(../../guide/index.html) GrantWriteACP='string',
ObjectLockEnabledForBucket=True|False
)
ACM (acm.html)
Parameters
AlexaForBusiness
CreateBucketConfiguration (dict) --
Amplify (amplify.html) LocationConstraint (string) --
APIGateway Specifies the region where the bucket will be created. If you don't
(apigateway.html) specify a region, the bucket is created in US East (N. Virginia) Region
(us-east-1).
Boto 3 Docs 1.9.249
applicable bucket.
TABLE OF CONTENTS ObjectLockEnabledForBucket (boolean) -- Specifies whether you want
Amazon S3 object lock to be enabled for the new bucket.
Response Syntax
Code Examples
{
User Guides 'Location': 'string'
ACM (acm.html) Response Structure
ACMPCA (acm-pca.html) (dict) --

AlexaForBusiness
Amplify (amplify.html) delete ()
APIGateway
Deletes the bucket. All objects (including all object versions and Delete Markers)
(apigateway.html)
in the bucket must be deleted before the bucket itself can be deleted.
Api
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucket)
api.html)
Boto 3 Docs 1.9.249 response = bucket.delete()
documentation (
../../index.html) Returns
None
TABLE OF CONTENTS
Quickstart delete_objects (**kwargs)

(../../guide/quickstart.html) This operation enables you to delete multiple objects from a bucket using a
A Sample Tutorial single HTTP request. You may specify up to 1000 keys.
Code Examples (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjects)
User Guides
(../../guide/index.html) response = bucket.delete_objects(
Delete={
'Objects': [
ACM (acm.html) {
ACMPCA (acm-pca.html) 'Key': 'string',
'VersionId': 'string'
AlexaForBusiness
},
],
Amplify (amplify.html) 'Quiet': True|False
},
APIGateway
(apigateway.html) MFA='string',
ApiGatewayManagement BypassGovernanceRetention=True|False
Api
)
api.html)
Parameters
Boto 3 Docs 1.9.249
Delete (dict) --
documentation (
[REQUIRED]
../../index.html)
Objects (list) -- [REQUIRED]
(dict) --
TABLE OF CONTENTS
Key name of the object to delete.
Quickstart
(../../guide/quickstart.html) VersionId (string) --
VersionId for the specific version of the object to delete.
A Sample Tutorial
(../../guide/sqs.html) Quiet (boolean) --
Element to enable quiet mode for the request. When you add this
Code Examples element, you must set its value to true.
User Guides number, a space, and the value that is displayed on your authentication
(../../guide/index.html) device.
ACM (acm.html) parameter in their requests. Documentation on downloading objects
AlexaForBusiness (http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
(alexaforbusiness.html) BypassGovernanceRetention (boolean) -- Specifies whether you want to
delete this object even if it has a Governance-type object lock in place.
You must have sufficient permissions to perform this operation.
APIGateway
(apigateway.html)
Return type
dict
Api Returns
(apigatewaymanagement Response Syntax
api.html)
Boto 3 Docs 1.9.249 {
../../index.html) {
'Key': 'string',
TABLE OF CONTENTS
Quickstart
},
],
Code Examples {
User Guides
'Code': 'string',
'Message': 'string'
]
ACM (acm.html)
}

(dict) --
Deleted (list) --
APIGateway
(apigateway.html)
(dict) --
Key (string) --
Boto 3 Docs 1.9.249
request.
documentation (
Errors (list) --
../../index.html)
(dict) --
Code (string) --
Quickstart
Message (string) --
A Sample Tutorial
(../../guide/sqs.html) download_file (Key, Filename, ExtraArgs=None, Callback=None, Config=None)
Code Examples Download an S3 object to a file.
Usage:
User Guides
(../../guide/index.html) import boto3
s3.Bucket('mybucket').download_file('hello.txt', '/tmp/hello.txt')
ACM (acm.html)
AlexaForBusiness parameters are capitalized. Detailed examples can be found at S3Transfer's
(alexaforbusiness.html) Usage.

APIGateway
Filename (str) -- The path to the file to download to.
(apigateway.html)
ApiGatewayManagement operation.
Api Callback (function) -- A method which takes a number of bytes
(apigatewaymanagement transferred to be periodically called during the download.
api.html)
Boto 3 Docs 1.9.249
documentation ( transfer configuration to be used when performing the transfer.
../../index.html)
TABLE OF CONTENTS download_fileobj (Key, Fileobj, ExtraArgs=None, Callback=None, Config=None)

Download an object from this bucket to a file-like-object.
Quickstart
This is a managed transfer which will perform a multipart download in multiple
A Sample Tutorial
Usage:
Code Examples
import boto3
User Guides s3 = boto3.resource('s3')
(../../guide/index.html) bucket = s3.Bucket('mybucket')
ACM (acm.html)
bucket.download_fileobj('mykey', data)
(alexaforbusiness.html) Fileobj (a file-like object) -- A file-like object to download into. At a
Amplify (amplify.html) minimum, it must implement the write method and must accept bytes.
APIGateway ExtraArgs (dict) -- Extra arguments that may be passed to the client
(apigateway.html) operation.
ApiGatewayManagement Callback (function) -- A method which takes a number of bytes
Api transferred to be periodically called during the download.
(apigatewaymanagement Config (boto3.s3.transfer.TransferConfig
api.html) (../customizations/s3.html#boto3.s3.transfer.TransferConfig)) -- The
transfer configuration to be used when performing the download.
Boto 3 Docs 1.9.249
documentation (
../../index.html) get_available_subresources ()
TABLE OF CONTENTS
Returns
Quickstart
(../../guide/quickstart.html) Return type
A Sample Tutorial
list of str
Code Examples load (*args, **kwargs)

Calls s3.Client.list_buckets() to update the attributes of the Bucket resource.
User Guides
put_object (**kwargs)
Available Services (index.html) Adds an object to a bucket.

Request Syntax
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 object = bucket.put_object(
TABLE OF CONTENTS
Quickstart
ContentLength=123,
A Sample Tutorial ContentType='string',
(../../guide/sqs.html) Expires=datetime(2015, 1, 1),
Code Examples GrantFullControl='string',
(../../guide/examples.html) GrantRead='string',
User Guides
Key='string',
Available Services (index.html) Metadata={
'string': 'string'
ACM (acm.html)
},
ACMPCA (acm-pca.html) ServerSideEncryption='AES256'|'aws:kms',
StorageClass='STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|'ONEZON
AlexaForBusiness
(alexaforbusiness.html) WebsiteRedirectLocation='string',
Amplify (amplify.html) SSECustomerKey='string',
APIGateway SSEKMSKeyId='string',
(apigateway.html) SSEKMSEncryptionContext='string',
Tagging='string',
Api
api.html) ObjectLockRetainUntilDate=datetime(2015, 1, 1),
Boto 3 Docs 1.9.249
)
documentation (
../../index.html)
Parameters
TABLE OF CONTENTS
Body (bytes or seekable file-like object) -- Object data.
Quickstart CacheControl (string) -- Specifies caching behavior along the
(../../guide/quickstart.html) request/reply chain.
A Sample Tutorial ContentDisposition (string) -- Specifies presentational information for
(../../guide/sqs.html) the object.
Code Examples applied to the object and thus what decoding mechanisms must be
(../../guide/examples.html) applied to obtain the media-type referenced by the Content-Type header
User Guides field.
(../../guide/index.html) ContentLanguage (string) -- The language the content is in.
Available Services (index.html) useful when the size of the body cannot be determined automatically.
ACM (acm.html)
ACMPCA (acm-pca.html) from the CLI. This parameted is required if object lock parameters are
AlexaForBusiness specified.
(alexaforbusiness.html) ContentType (string) -- A standard MIME type describing the format of
the object data.
Amplify (amplify.html) Expires (datetime) -- The date and time at which the object is no longer
APIGateway cacheable.
(apigateway.html) GrantFullControl (string) -- Gives the grantee READ, READ_ACP, and
ApiGatewayManagement GrantRead (string) -- Allows grantee to read the object data and its
Api metadata.
(apigatewaymanagement GrantReadACP (string) -- Allows grantee to read the object ACL.
api.html)
Boto 3 Docs 1.9.249
applicable object.
documentation ( Key (string) --
../../index.html) [REQUIRED]
Object key for which the PUT operation was initiated.

TABLE OF CONTENTS
Metadata (dict) --
Quickstart
(../../guide/quickstart.html) (string) --
(string) --
A Sample Tutorial
Code Examples StorageClass (string) -- The type of storage to use for the object. Defaults
(../../guide/examples.html) to 'STANDARD'.
User Guides
website, redirects requests for this object to another object in the same
Available Services (index.html) in the object metadata.
ACM (acm.html)
ACMPCA (acm-pca.html) SSECustomerKey (string) -- Specifies the customer-provided encryption
AlexaForBusiness
Amplify (amplify.html) the x-amz-server-side-encryption-customer-algorithm header.
APIGateway
(apigateway.html)
ApiGatewayManagement ensure the encryption key was transmitted without error.
Api
api.html)
Boto 3 Docs 1.9.249 Please note that this parameter is automatically populated if it is not
documentation ( provided. Including this parameter is not required
../../index.html)
TABLE OF CONTENTS encryption. All GET and PUT requests for an object protected by AWS KMS
Quickstart any of the officially supported AWS SDKs and CLI can be found at
(../../guide/quickstart.html) http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-
signature-version
A Sample Tutorial
signature-version)
Code Examples SSEKMSEncryptionContext (string) -- Specifies the AWS KMS Encryption
(../../guide/examples.html) Context to use for object encryption. The value of this header is a base64-
User Guides
pairs.
Available Services (index.html) he will be charged for the request. Bucket owners need not specify this
ACM (acm.html)
ACMPCA (acm-pca.html) http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
AlexaForBusiness
as URL Query parameters. (For example, "Key1=Value1")
Amplify (amplify.html) ObjectLockMode (string) -- The object lock mode that you want to apply
to this object.
APIGateway
ObjectLockRetainUntilDate (datetime) -- The date and time when you
(apigateway.html)
want this object's object lock to expire.
ApiGatewayManagement ObjectLockLegalHoldStatus (string) -- The Legal Hold status that you
Api want to apply to the specified object.
Return type
api.html)
s3.Object
Boto 3 Docs 1.9.249
Object resource
../../index.html)
TABLE OF CONTENTS
upload_file (Filename, Key, ExtraArgs=None, Callback=None, Config=None)
Quickstart
(../../guide/quickstart.html) Usage:
A Sample Tutorial
Code Examples
s3.Bucket('mybucket').upload_file('/tmp/hello.txt', 'hello.txt')
User Guides
Similar behavior as S3Transfer's upload_file() method, except that parameters
are capitalized. Detailed examples can be found at S3Transfer's Usage.
Parameters
ACM (acm.html) Filename (str) -- The path to the file to upload.
Key (str) -- The name of the key to upload to.
AlexaForBusiness operation.
(alexaforbusiness.html) Callback (function) -- A method which takes a number of bytes
Amplify (amplify.html) transferred to be periodically called during the upload.
APIGateway (../customizations/s3.html#boto3.s3.transfer.TransferConfig)) -- The
(apigateway.html) transfer configuration to be used when performing the transfer.
Api
(apigatewaymanagement upload_fileobj (Fileobj, Key, ExtraArgs=None, Callback=None, Config=None)
api.html) Upload a file-like object to this bucket.
Boto 3 Docs 1.9.249
documentation ( This is a managed transfer which will perform a multipart upload in multiple
../../index.html)
Usage:
TABLE OF CONTENTS
import boto3
Quickstart s3 = boto3.resource('s3')
(../../guide/quickstart.html) bucket = s3.Bucket('mybucket')
A Sample Tutorial
(../../guide/sqs.html) with open('filename', 'rb') as data:
bucket.upload_fileobj(data, 'mykey')
Code Examples
Parameters
User Guides
Fileobj (a file-like object) -- A file-like object to upload. At a minimum, it
must implement the read method, and must return bytes.
Available Services (index.html) Key (str) -- The name of the key to upload to.
ACM (acm.html)
operation.
ACMPCA (acm-pca.html) Callback (function) -- A method which takes a number of bytes
transferred to be periodically called during the upload.
AlexaForBusiness
Amplify (amplify.html) transfer configuration to be used when performing the upload.
APIGateway
(apigateway.html)
Sub-resources
ApiGatewayManagement Sub-resources are methods that create a new instance of a child resource. This
Api resource's identifiers get passed along to the child. For more information about
(apigatewaymanagement sub-resources refer to the Resources Introduction Guide
api.html) (../../guide/resources.html#subresources-intro).
Boto 3 Docs 1.9.249 Acl ()
documentation ( Creates a BucketAcl resource.:
../../index.html)
bucket_acl = bucket.Acl()
TABLE OF CONTENTS
Return type
Quickstart S3.BucketAcl
Returns
A Sample Tutorial
A BucketAcl resource
Code Examples
(../../guide/examples.html) Cors ()
User Guides
Creates a BucketCors resource.:
bucket_cors = bucket.Cors()
ACM (acm.html)
Return type
S3.BucketCors
AlexaForBusiness
Returns
A BucketCors resource
APIGateway
(apigateway.html) Lifecycle ()
Creates a BucketLifecycle resource.:
Api
(apigatewaymanagement bucket_lifecycle = bucket.Lifecycle()
api.html)
Return type
Boto 3 Docs 1.9.249
S3.BucketLifecycle
documentation (
A BucketLifecycle resource
TABLE OF CONTENTS
LifecycleConfiguration ()
Quickstart
(../../guide/quickstart.html) Creates a BucketLifecycleConfiguration resource.:
A Sample Tutorial
(../../guide/sqs.html) bucket_lifecycle_configuration = bucket.LifecycleConfiguration()
Code Examples
S3.BucketLifecycleConfiguration
User Guides
A BucketLifecycleConfiguration resource
ACM (acm.html)
Logging ()
Creates a BucketLogging resource.:
AlexaForBusiness
bucket_logging = bucket.Logging()
APIGateway
Return type
(apigateway.html)
S3.BucketLogging
Api Returns
(apigatewaymanagement A BucketLogging resource
api.html)
Boto 3 Docs 1.9.249 Notification ()
Creates a BucketNotification resource.:
documentation (
../../index.html)
bucket_notification = bucket.Notification()
TABLE OF CONTENTS
Return type
Quickstart S3.BucketNotification
Returns
A Sample Tutorial
A BucketNotification resource
Code Examples
(../../guide/examples.html) Object (key)
User Guides
object = bucket.Object('key')
ACM (acm.html)
Parameters
key (string) -- The Object's key identifier. This must be set.
AlexaForBusiness
Return type
S3.Object
Returns
APIGateway A Object resource
(apigateway.html)
Api Policy ()
(apigatewaymanagement Creates a BucketPolicy resource.:
api.html)
Boto 3 Docs 1.9.249 bucket_policy = bucket.Policy()
documentation (
S3.BucketPolicy
TABLE OF CONTENTS
Returns
Quickstart A BucketPolicy resource
A Sample Tutorial RequestPayment ()

Creates a BucketRequestPayment resource.:
Code Examples
bucket_request_payment = bucket.RequestPayment()
User Guides
Return type
Available Services (index.html) S3.BucketRequestPayment

ACMPCA (acm-pca.html) A BucketRequestPayment resource
AlexaForBusiness
(alexaforbusiness.html) Tagging ()
Amplify (amplify.html) Creates a BucketTagging resource.:
APIGateway
(apigateway.html) bucket_tagging = bucket.Tagging()
Api Return type
S3.BucketTagging
api.html)
Returns
Boto 3 Docs 1.9.249
A BucketTagging resource
documentation (
../../index.html)
Versioning ()
TABLE OF CONTENTS Creates a BucketVersioning resource.:
Quickstart
bucket_versioning = bucket.Versioning()
A Sample Tutorial
S3.BucketVersioning
Code Examples
A BucketVersioning resource
User Guides
Available Services (index.html) Website ()

Creates a BucketWebsite resource.:
ACM (acm.html)
bucket_website = bucket.Website()
AlexaForBusiness
Return type
S3.BucketWebsite
APIGateway
Returns
(apigateway.html)
A BucketWebsite resource
Api
(apigatewaymanagement Collections
api.html)
Boto 3 Docs 1.9.249
For more information about collections refer to the Resources Introduction Guide
documentation ( (../../guide/collections.html#guide-collections).
../../index.html)
multipart_uploads
A collection of MultipartUpload resources
TABLE OF CONTENTS
all ()
Quickstart Creates an iterable of all MultipartUpload resources in the collection.
A Sample Tutorial (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-
(../../guide/sqs.html) 01/ListMultipartUploads)
User Guides multipart_upload_iterator = bucket.multipart_uploads.all()

ACM (acm.html) list( s3.MultipartUpload )

A list of MultipartUpload resources
AlexaForBusiness
Amplify (amplify.html) filter (**kwargs)
APIGateway Creates an iterable of all MultipartUpload resources in the collection

(apigateway.html) filtered by kwargs passed to method.

(apigatewaymanagement 01/ListMultipartUploads)
Boto 3 Docs 1.9.249 multipart_upload_iterator = bucket.multipart_uploads.filter(
documentation ( Delimiter='string',
../../index.html) EncodingType='url',
KeyMarker='string',
MaxUploads=123,
TABLE OF CONTENTS
Prefix='string',
UploadIdMarker='string'
Quickstart
)
A Sample Tutorial
Delimiter (string) -- Character you use to group keys.
Code Examples
EncodingType (string) -- Requests Amazon S3 to encode the object
keys in the response and specifies the encoding method to use. An
User Guides object key may contain any Unicode character; however, XML 1.0
(../../guide/index.html) parser cannot parse some characters, such as characters with an
ASCII value from 0 to 10. For characters that are not supported in
Available Services (index.html) XML 1.0, you can add this parameter to request that Amazon S3
ACM (acm.html) encode the keys in the response.
KeyMarker (string) -- Together with upload-id-marker, this parameter
ACMPCA (acm-pca.html) specifies the multipart upload after which listing should begin.
AlexaForBusiness MaxUploads (integer) -- Sets the maximum number of multipart
(alexaforbusiness.html) uploads, from 1 to 1,000, to return in the response body. 1,000 is the
maximum number of uploads that can be returned in a response.
Prefix (string) -- Lists in-progress uploads only for those keys that
APIGateway begin with the specified prefix.
(apigateway.html) UploadIdMarker (string) -- Together with key-marker, specifies the
multipart upload after which listing should begin. If key-marker is not
specified, the upload-id-marker parameter is ignored.
Api
api.html) list( s3.MultipartUpload )
Returns
Boto 3 Docs 1.9.249
documentation (
../../index.html)
limit (**kwargs)
TABLE OF CONTENTS Creates an iterable up to a specified amount of MultipartUpload resources
in the collection.
Quickstart
A Sample Tutorial 01/ListMultipartUploads)
Request Syntax
Code Examples
multipart_upload_iterator = bucket.multipart_uploads.limit(
User Guides count=123

Parameters
ACM (acm.html)
count (integer) -- The limit to the number of resources in the iterable.
Return type
AlexaForBusiness
list( s3.MultipartUpload )
Returns
APIGateway
(apigateway.html)
ApiGatewayManagement page_size (**kwargs)

Api Creates an iterable of all MultipartUpload resources in the collection, but
(apigatewaymanagement limits the number of items returned by each service call by the specified
api.html) amount.
Boto 3 Docs 1.9.249
documentation ( 01/ListMultipartUploads)
../../index.html)
Request Syntax
TABLE OF CONTENTS
multipart_upload_iterator = bucket.multipart_uploads.page_size(
Quickstart count=123
A Sample Tutorial
count (integer) -- The number of items returned by each service call
Code Examples
list( s3.MultipartUpload )
User Guides
ACM (acm.html)
object_versions
A collection of ObjectVersion resources
AlexaForBusiness
(alexaforbusiness.html) all ()
Creates an iterable of all ObjectVersion resources in the collection.
APIGateway
(apigateway.html)
01/ListObjectVersions)
Request Syntax
Api
api.html)
Boto 3 Docs 1.9.249 object_version_iterator = bucket.object_versions.all()
documentation (
list( s3.ObjectVersion )
TABLE OF CONTENTS
Returns
Quickstart A list of ObjectVersion resources
A Sample Tutorial delete (**kwargs)

Code Examples single HTTP request. You may specify up to 1000 keys.
User Guides (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjects)
ACM (acm.html) response = bucket.object_versions.delete(

MFA='string',
AlexaForBusiness BypassGovernanceRetention=True|False
(apigateway.html) MFA (string) -- The concatenation of the authentication device's serial
number, a space, and the value that is displayed on your
authentication device.
Api
RequestPayer (string) -- Confirms that the requester knows that she
or he will be charged for the request. Bucket owners need not specify
api.html)
this parameter in their requests. Documentation on downloading
objects from requester pays buckets can be found at
Boto 3 Docs 1.9.249
http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPays
documentation ( (http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPays
../../index.html) BypassGovernanceRetention (boolean) -- Specifies whether you
want to delete this object even if it has a Governance-type object lock
TABLE OF CONTENTS in place. You must have sufficient permissions to perform this
operation.
Response Syntax
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
../../index.html) {
'Key': 'string',
TABLE OF CONTENTS
Quickstart
},
],
Code Examples {
User Guides
'Code': 'string',
'Message': 'string'
]
ACM (acm.html)
}

(dict) --
Deleted (list) --
APIGateway
(dict) --
(apigateway.html)
Key (string) --
If present, indicates that the requester was successfully charged for
Boto 3 Docs 1.9.249
the request.
documentation (
Errors (list) --
../../index.html)
(dict) --
Code (string) --
Quickstart
Message (string) --
A Sample Tutorial
(../../guide/sqs.html) filter (**kwargs)
Code Examples Creates an iterable of all ObjectVersion resources in the collection filtered
(../../guide/examples.html) by kwargs passed to method.
User Guides See also: AWS API Documentation

(../../guide/index.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-
Request Syntax
ACM (acm.html)
ACMPCA (acm-pca.html) object_version_iterator = bucket.object_versions.filter(

AlexaForBusiness Delimiter='string',
(alexaforbusiness.html) EncodingType='url',
KeyMarker='string',
MaxKeys=123,
APIGateway Prefix='string',
(apigateway.html) VersionIdMarker='string'
)
Api
api.html)
Boto 3 Docs 1.9.249
documentation ( keys in the response and specifies the encoding method to use. An
../../index.html) object key may contain any Unicode character; however, XML 1.0
parser cannot parse some characters, such as characters with an
TABLE OF CONTENTS ASCII value from 0 to 10. For characters that are not supported in
XML 1.0, you can add this parameter to request that Amazon S3
Quickstart encode the keys in the response.
(../../guide/quickstart.html) KeyMarker (string) -- Specifies the key to start with when listing
objects in a bucket.
A Sample Tutorial MaxKeys (integer) -- Sets the maximum number of keys returned in
(../../guide/sqs.html) the response. The response might contain fewer keys but will never
Code Examples contain more.
(../../guide/examples.html) Prefix (string) -- Limits the response to keys that begin with the
specified prefix.
User Guides VersionIdMarker (string) -- Specifies the object version you want to
(../../guide/index.html) start listing from.
ACM (acm.html)

A list of ObjectVersion resources
AlexaForBusiness
Amplify (amplify.html) limit (**kwargs)
APIGateway Creates an iterable up to a specified amount of ObjectVersion resources in

(apigateway.html) the collection.

(apigatewaymanagement 01/ListObjectVersions)
Boto 3 Docs 1.9.249 object_version_iterator = bucket.object_versions.limit(
documentation ( count=123
../../index.html) )

Quickstart
Return type
A Sample Tutorial
Code Examples
User Guides page_size (**kwargs)

(../../guide/index.html) Creates an iterable of all ObjectVersion resources in the collection, but
limits the number of items returned by each service call by the specified
amount.
ACM (acm.html)
ACMPCA (acm-pca.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-
AlexaForBusiness
(alexaforbusiness.html) Request Syntax
object_version_iterator = bucket.object_versions.page_size(
APIGateway
count=123
(apigateway.html)
)
Api
api.html) count (integer) -- The number of items returned by each service call
Return type
Boto 3 Docs 1.9.249
documentation (
TABLE OF CONTENTS
objects
Quickstart
A collection of ObjectSummary resources
A Sample Tutorial all ()

(../../guide/sqs.html) Creates an iterable of all ObjectSummary resources in the collection.

(../../guide/examples.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjects)

object_summary_iterator = bucket.objects.all()
ACM (acm.html)
Return type
list( s3.ObjectSummary )
AlexaForBusiness
Returns
A list of ObjectSummary resources
APIGateway
(apigateway.html) delete (**kwargs)
single HTTP request. You may specify up to 1000 keys.
Api
api.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjects)
Request Syntax
Boto 3 Docs 1.9.249
documentation (
response = bucket.objects.delete(
../../index.html)
MFA='string',
TABLE OF CONTENTS
)
Quickstart
Parameters
A Sample Tutorial
(../../guide/sqs.html) MFA (string) -- The concatenation of the authentication device's serial
number, a space, and the value that is displayed on your
Code Examples authentication device.
(../../guide/examples.html) RequestPayer (string) -- Confirms that the requester knows that she
User Guides
this parameter in their requests. Documentation on downloading
objects from requester pays buckets can be found at
Available Services (index.html) http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPays
(http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPays
ACM (acm.html)
BypassGovernanceRetention (boolean) -- Specifies whether you
ACMPCA (acm-pca.html) want to delete this object even if it has a Governance-type object lock
in place. You must have sufficient permissions to perform this
AlexaForBusiness
operation.
Return type
dict
APIGateway
ApiGatewayManagement Response Syntax

Api
api.html)
Boto 3 Docs 1.9.249 {
../../index.html) {
'Key': 'string',
TABLE OF CONTENTS
Quickstart
},
],
Code Examples {
User Guides
'Code': 'string',
'Message': 'string'
]
ACM (acm.html)
}

(dict) --
Deleted (list) --
APIGateway
(dict) --
(apigateway.html)
Key (string) --
If present, indicates that the requester was successfully charged for
Boto 3 Docs 1.9.249
the request.
documentation (
Errors (list) --
../../index.html)
(dict) --
Code (string) --
Quickstart
Message (string) --
A Sample Tutorial
(../../guide/sqs.html) filter (**kwargs)
Code Examples Creates an iterable of all ObjectSummary resources in the collection filtered
(../../guide/examples.html) by kwargs passed to method.

(../../guide/index.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjects)
Request Syntax
ACM (acm.html)
object_summary_iterator = bucket.objects.filter(
ACMPCA (acm-pca.html) Delimiter='string',
AlexaForBusiness EncodingType='url',
(alexaforbusiness.html) Marker='string',
MaxKeys=123,
Prefix='string',
APIGateway RequestPayer='requester'
(apigateway.html) )
Api Parameters
api.html)
Boto 3 Docs 1.9.249
keys in the response and specifies the encoding method to use. An
documentation ( object key may contain any Unicode character; however, XML 1.0
../../index.html) parser cannot parse some characters, such as characters with an
ASCII value from 0 to 10. For characters that are not supported in
TABLE OF CONTENTS XML 1.0, you can add this parameter to request that Amazon S3
encode the keys in the response.
Quickstart Marker (string) -- Specifies the key to start with when listing objects in
(../../guide/quickstart.html) a bucket.
MaxKeys (integer) -- Sets the maximum number of keys returned in
A Sample Tutorial the response. The response might contain fewer keys but will never
(../../guide/sqs.html) contain more.
Code Examples Prefix (string) -- Limits the response to keys that begin with the
(../../guide/examples.html) specified prefix.
User Guides or he will be charged for the list objects request. Bucket owners need
(../../guide/index.html) not specify this parameter in their requests.
ACM (acm.html)

AlexaForBusiness
Amplify (amplify.html) limit (**kwargs)
APIGateway Creates an iterable up to a specified amount of ObjectSummary resources

(apigateway.html) in the collection.

Api (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjects)
api.html)
Boto 3 Docs 1.9.249 object_summary_iterator = bucket.objects.limit(
documentation ( count=123
../../index.html) )

Quickstart
Return type
A Sample Tutorial
Code Examples
User Guides page_size (**kwargs)

(../../guide/index.html) Creates an iterable of all ObjectSummary resources in the collection, but
limits the number of items returned by each service call by the specified
amount.
ACM (acm.html)
ACMPCA (acm-pca.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjects)

Amplify (amplify.html) object_summary_iterator = bucket.objects.page_size(

count=123
APIGateway
)
(apigateway.html)
Api Parameters
(apigatewaymanagement count (integer) -- The number of items returned by each service call
api.html)
Return type
Boto 3 Docs 1.9.249
documentation (
TABLE OF CONTENTS
Waiters
Quickstart
Waiters provide an interface to wait for a resource to reach a specific state. For
more information about waiters refer to the Resources Introduction Guide
A Sample Tutorial (../../guide/resources.html#waiters-intro).
wait_until_exists ()
Code Examples Waits until this Bucket is exists. This method calls
(../../guide/examples.html) S3.Waiter.bucket_exists.wait() which polls. S3.Client.head_bucket() every
User Guides 5 seconds until a successful state is reached. An error is returned after 20 failed
(../../guide/index.html) checks.
ACM (acm.html)
Request Syntax
AlexaForBusiness bucket.wait_until_exists()
Amplify (amplify.html) Returns

APIGateway None
(apigateway.html)
wait_until_not_exists ()
Api
api.html)
Waits until this Bucket is not exists. This method calls
Boto 3 Docs 1.9.249
S3.Waiter.bucket_not_exists.wait() which polls. S3.Client.head_bucket()
documentation ( every 5 seconds until a successful state is reached. An error is returned after 20
../../index.html) failed checks.
TABLE OF CONTENTS (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadBucket)
Request Syntax
Quickstart
A Sample Tutorial bucket.wait_until_not_exists()


User Guides
Available Services (index.html) BucketAcl

ACM (acm.html)
class S3. BucketAcl (bucket_name)
A resource representing an Amazon Simple Storage Service (S3) BucketAcl:
AlexaForBusiness
import boto3
APIGateway s3 = boto3.resource('s3')
(apigateway.html) bucket_acl = s3.BucketAcl('bucket_name')
Api Parameters
bucket_name (string) -- The BucketAcl's bucket_name identifier. This must be
api.html)
set.
These are the resource's available identifiers:
Boto 3 Docs 1.9.249
documentation ( bucket_name
../../index.html) These are the resource's available attributes:

grants
TABLE OF CONTENTS owner
Quickstart
(../../guide/quickstart.html) get_available_subresources()
A Sample Tutorial load()
(../../guide/sqs.html) put()
reload()
Code Examples
(../../guide/examples.html) These are the resource's available sub-resources:
Bucket()
User Guides
(../../guide/index.html) Identifiers
ACM (acm.html) Introduction Guide (../../guide/resources.html#identifiers-attributes-intro).
ACMPCA (acm-pca.html) bucket_name
AlexaForBusiness (string) The BucketAcl's bucket_name identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded
APIGateway the first time one is accessed via the load() method. For more information about
(apigateway.html) attributes refer to the Resources Introduction Guide
(../../guide/resources.html#identifiers-attributes-intro).
Api grants
(apigatewaymanagement (list) --
api.html)
A list of grants.
Boto 3 Docs 1.9.249
../../index.html) Grantee (dict) --

TABLE OF CONTENTS
Quickstart EmailAddress (string) --

A Sample Tutorial
ID (string) --
Code Examples
(../../guide/examples.html) Type (string) --
User Guides Type of grantee

(../../guide/index.html) URI (string) --
Available Services (index.html) URI of the grantee group.
ACM (acm.html) Permission (string) --
ACMPCA (acm-pca.html) Specifies the permission given to the grantee.
AlexaForBusiness
owner
(dict) --
Amplify (amplify.html) DisplayName (string) --
(apigateway.html)
Actions
ApiGatewayManagement Actions call operations on resources. They may automatically handle the passing in
Api of arguments set from identifiers and some attributes. For more information about
(apigatewaymanagement actions refer to the Resources Introduction Guide
api.html) (../../guide/resources.html#actions-intro).
Boto 3 Docs 1.9.249 get_available_subresources ()
documentation (
list of str
Quickstart
A Sample Tutorial load ()

(../../guide/sqs.html) Calls S3.Client.get_bucket_acl() to update the attributes of the BucketAcl
resource. Note that the load and reload methods are the same method and can
Code Examples
be used interchangeably.
User Guides
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/None)
Request Syntax
ACM (acm.html) bucket_acl.load()

(alexaforbusiness.html) None
APIGateway put (**kwargs)

(apigateway.html)
Sets the permissions on a bucket using access control lists (ACL).
Api
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAcl)
Boto 3 Docs 1.9.249 response = bucket_acl.put(
'Grants': [
{
TABLE OF CONTENTS
'Grantee': {
Quickstart
'ID': 'string',
Code Examples },
},
User Guides
],
'Owner': {
'ID': 'string'
ACM (acm.html)
}
AlexaForBusiness
(alexaforbusiness.html) GrantRead='string',
Amplify (amplify.html) GrantWrite='string',
APIGateway GrantWriteACP='string'
(apigateway.html) )
Api
api.html) ACL (string) -- The canned ACL to apply to the bucket.
Boto 3 Docs 1.9.249
Contains the elements that set the ACL permissions for an object per
documentation ( grantee.
../../index.html)
Grants (list) --
A list of grants.
TABLE OF CONTENTS
(dict) --
Grantee (dict) --
Quickstart
A Sample Tutorial
Code Examples
ID (string) --
User Guides
Type of grantee
Available Services (index.html) URI (string) --
ACM (acm.html) URI of the grantee group.
ACMPCA (acm-pca.html) Permission (string) --

AlexaForBusiness
(alexaforbusiness.html) Owner (dict) --
Container for the bucket owner's display name and ID.
(apigateway.html) GrantFullControl (string) -- Allows grantee the read, write, read ACP, and
ApiGatewayManagement write ACP permissions on the bucket.
Api GrantRead (string) -- Allows grantee to list the objects in the bucket.
(apigatewaymanagement GrantReadACP (string) -- Allows grantee to read the bucket ACL.
api.html)
Boto 3 Docs 1.9.249
object in the bucket.
documentation ( GrantWriteACP (string) -- Allows grantee to write the ACL for the
../../index.html) applicable bucket.
Returns
TABLE OF CONTENTS
None
Quickstart
(../../guide/quickstart.html) reload ()
A Sample Tutorial Calls S3.Client.get_bucket_acl() to update the attributes of the BucketAcl
(../../guide/sqs.html) resource. Note that the load and reload methods are the same method and can
Code Examples
User Guides

bucket_acl.reload()
ACM (acm.html)
Returns
AlexaForBusiness None
Sub-resources
APIGateway Sub-resources are methods that create a new instance of a child resource. This
(apigateway.html) resource's identifiers get passed along to the child. For more information about
ApiGatewayManagement sub-resources refer to the Resources Introduction Guide
Api (../../guide/resources.html#subresources-intro).
Bucket ()
api.html)
Creates a Bucket resource.:
Boto 3 Docs 1.9.249
documentation (
bucket = bucket_acl.Bucket()
../../index.html)

S3.Bucket
Quickstart
Returns
A Bucket resource
A Sample Tutorial
Code Examples
(../../guide/examples.html) BucketCors
User Guides
(../../guide/index.html) class S3. BucketCors (bucket_name)
A resource representing an Amazon Simple Storage Service (S3) BucketCors:
ACM (acm.html)
import boto3
AlexaForBusiness
bucket_cors = s3.BucketCors('bucket_name')
Parameters
APIGateway
bucket_name (string) -- The BucketCors's bucket_name identifier. This must be
(apigateway.html)
set.
Api These are the resource's available identifiers:
bucket_name
api.html)
Boto 3 Docs 1.9.249
documentation ( cors_rules
../../index.html) These are the resource's available actions:
delete()
TABLE OF CONTENTS get_available_subresources()
load()
Quickstart put()
(../../guide/quickstart.html) reload()
A Sample Tutorial These are the resource's available sub-resources:
Bucket()
Code Examples
(../../guide/examples.html) Identifiers
User Guides resource. For more information about identifiers refer to the Resources
(../../guide/index.html) Introduction Guide (../../guide/resources.html#identifiers-attributes-intro).
Available Services (index.html) bucket_name
ACM (acm.html) (string) The BucketCors's bucket_name identifier. This must be set.
ACMPCA (acm-pca.html) Attributes

AlexaForBusiness Attributes provide access to the properties of a resource. Attributes are lazy-loaded
(alexaforbusiness.html) the first time one is accessed via the load() method. For more information about
attributes refer to the Resources Introduction Guide
APIGateway
cors_rules
(apigateway.html)
(list) --
Api (dict) --
(apigatewaymanagement Specifies a cross-origin access rule for an Amazon S3 bucket.
api.html)
AllowedHeaders (list) --
Boto 3 Docs 1.9.249
documentation ( Headers that are specified in the Access-Control-Request-
Headers header. These headers are allowed in a preflight
../../index.html)
OPTIONS request. In response to any preflight OPTIONS
request, Amazon S3 returns any requested headers that are
TABLE OF CONTENTS
allowed.
(../../guide/quickstart.html) AllowedMethods (list) --
A Sample Tutorial An HTTP method that you allow the origin to execute. Valid
(../../guide/sqs.html) values are GET , PUT , HEAD , POST , and DELETE .

(../../guide/examples.html) AllowedOrigins (list) --
One or more origins you want customers to be able to access
User Guides
the bucket from.
(string) --
ACM (acm.html)
One or more headers in the response that you want customers
ACMPCA (acm-pca.html) to be able to access from their applications (for example, from
a JavaScript XMLHttpRequest object).
AlexaForBusiness
(alexaforbusiness.html) (string) --
APIGateway
response for the specified resource.
(apigateway.html)
ApiGatewayManagement Actions
Api Actions call operations on resources. They may automatically handle the passing in
(apigatewaymanagement of arguments set from identifiers and some attributes. For more information about
api.html) actions refer to the Resources Introduction Guide
Boto 3 Docs 1.9.249
documentation ( delete ()
../../index.html) Deletes the CORS configuration information set for the bucket.
TABLE OF CONTENTS (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketCors)
Request Syntax
Quickstart
response = bucket_cors.delete()
A Sample Tutorial
Code Examples
Returns
User Guides
(../../guide/index.html) get_available_subresources ()
Available Services (index.html) Returns a list of all the available sub-resources for this Resource.

Return type
AlexaForBusiness
list of str
APIGateway load ()
(apigateway.html) Calls S3.Client.get_bucket_cors() to update the attributes of the BucketCors
Api
api.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/None)
Request Syntax
Boto 3 Docs 1.9.249
documentation (
bucket_cors.load()
../../index.html)

None
Quickstart
put (**kwargs)
A Sample Tutorial
(../../guide/sqs.html) Sets the CORS configuration for a bucket.

(../../guide/examples.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketCors)
Request Syntax
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = bucket_cors.put(
documentation ( CORSConfiguration={
../../index.html) 'CORSRules': [
{
'AllowedHeaders': [
TABLE OF CONTENTS
'string',
],
Quickstart
'AllowedMethods': [
'string',
A Sample Tutorial ],
(../../guide/sqs.html) 'AllowedOrigins': [
Code Examples 'string',
(../../guide/examples.html) ],
'ExposeHeaders': [
User Guides
'string',
],
Available Services (index.html) 'MaxAgeSeconds': 123
},
ACM (acm.html)
]
AlexaForBusiness
Parameters
APIGateway
CORSConfiguration (dict) --
(apigateway.html)
[REQUIRED]
CORSRules (list) -- [REQUIRED]
Api
A set of allowed origins and methods.
api.html) (dict) --
Specifies a cross-origin access rule for an Amazon S3 bucket.
Boto 3 Docs 1.9.249
documentation ( AllowedHeaders (list) --
Headers that are specified in the Access-Control-Request-Headers
../../index.html)
header. These headers are allowed in a preflight OPTIONS request. In
response to any preflight OPTIONS request, Amazon S3 returns any
TABLE OF CONTENTS requested headers that are allowed.
(string) --
Quickstart
AllowedMethods (list) -- [REQUIRED]
A Sample Tutorial are GET , PUT , HEAD , POST , and DELETE .
(string) --
Code Examples AllowedOrigins (list) -- [REQUIRED]
(../../guide/examples.html) One or more origins you want customers to be able to access the
bucket from.
User Guides
(../../guide/index.html) (string) --
One or more headers in the response that you want customers to be
ACM (acm.html) able to access from their applications (for example, from a JavaScript
XMLHttpRequest object).
(string) --
AlexaForBusiness
Amplify (amplify.html) response for the specified resource.
APIGateway Returns
(apigateway.html) None
Api
(apigatewaymanagement reload ()
api.html)
Calls S3.Client.get_bucket_cors() to update the attributes of the BucketCors
Boto 3 Docs 1.9.249
documentation ( be used interchangeably.
../../index.html)
TABLE OF CONTENTS
Request Syntax
Quickstart
(../../guide/quickstart.html) bucket_cors.reload()
A Sample Tutorial
Code Examples None
User Guides Sub-resources

(../../guide/index.html) Sub-resources are methods that create a new instance of a child resource. This
Available Services (index.html) resource's identifiers get passed along to the child. For more information about
sub-resources refer to the Resources Introduction Guide
ACM (acm.html) (../../guide/resources.html#subresources-intro).
Bucket ()
AlexaForBusiness Creates a Bucket resource.:
Amplify (amplify.html) bucket = bucket_cors.Bucket()

APIGateway
(apigateway.html)
Return type
ApiGatewayManagement S3.Bucket
Api
Returns
api.html) A Bucket resource
Boto 3 Docs 1.9.249
documentation (
../../index.html)
BucketLifecycle
TABLE OF CONTENTS class S3. BucketLifecycle (bucket_name)
A resource representing an Amazon Simple Storage Service (S3) BucketLifecycle:
Quickstart
import boto3
A Sample Tutorial
(../../guide/sqs.html) s3 = boto3.resource('s3')
Code Examples bucket_lifecycle = s3.BucketLifecycle('bucket_name')


(../../guide/index.html) bucket_name (string) -- The BucketLifecycle's bucket_name identifier. This
must be set.
ACM (acm.html)
bucket_name
AlexaForBusiness These are the resource's available attributes:

(alexaforbusiness.html) rules
Amplify (amplify.html) These are the resource's available actions:
APIGateway delete()
(apigateway.html) get_available_subresources()
ApiGatewayManagement load()
Api put()
(apigatewaymanagement reload()
api.html)
Boto 3 Docs 1.9.249
documentation ( Bucket()
../../index.html) Identifiers
TABLE OF CONTENTS resource. For more information about identifiers refer to the Resources
Introduction Guide (../../guide/resources.html#identifiers-attributes-intro).
Quickstart bucket_name
(string) The BucketLifecycle's bucket_name identifier. This must be set.
A Sample Tutorial
(../../guide/sqs.html) Attributes
Code Examples
the first time one is accessed via the load() method. For more information about
User Guides (../../guide/resources.html#identifiers-attributes-intro).
(../../guide/index.html) rules
Available Services (index.html) (list) --
ACMPCA (acm-pca.html) Specifies lifecycle rules for an Amazon S3 bucket. For more
information, see PUT Bucket lifecycle
AlexaForBusiness
APIGateway
Date (datetime) --
(apigateway.html)
Indicates at what date the object is to be moved or
deleted. Should be in GMT ISO 8601 Format.
Api
(apigatewaymanagement Days (integer) --
api.html)
Indicates the lifetime, in days, of the objects that are
Boto 3 Docs 1.9.249
subject to the rule. The value must be a non-zero positive
documentation ( integer.
../../index.html)
TABLE OF CONTENTS Indicates whether Amazon S3 will remove a delete marker

with no noncurrent versions. If set to true, the delete
marker will be expired; if set to false the policy takes no
Quickstart
action. This cannot be specified with Days or Date in a
Lifecycle Expiration Policy.
A Sample Tutorial
ID (string) --
Unique identifier for the rule. The value can't be longer than
Code Examples
255 characters.
Prefix (string) --
User Guides
(../../guide/index.html) Object key prefix that identifies one or more objects to which
this rule applies.
Status (string) --
ACM (acm.html)
If Enabled , the rule is currently being applied. If Disabled , the
ACMPCA (acm-pca.html) rule is not currently being applied.
AlexaForBusiness Transition (dict) --
Date (datetime) --
Indicates when objects are transitioned to the specified
APIGateway storage class. The date value must be in ISO 8601 format.
(apigateway.html) The time is always midnight UTC.
ApiGatewayManagement Days (integer) --
Api
api.html)
Indicates the number of days after creation when objects
Boto 3 Docs 1.9.249
are transitioned to the specified storage class. The value
documentation ( must be a positive integer.
../../index.html)
TABLE OF CONTENTS The storage class to which you want the object to
transition.
Quickstart NoncurrentVersionTransition (dict) --
A Sample Tutorial
Specifies the number of days an object is noncurrent
before Amazon S3 can perform the associated action. For
Code Examples information about the noncurrent days calculations, see
(../../guide/examples.html) How Amazon S3 Calculates When an Object Became
Noncurrent
User Guides
(https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-
access-control.html) in the Amazon Simple Storage Service
Available Services (index.html) Developer Guide .
AlexaForBusiness NoncurrentVersionExpiration (dict) --

(alexaforbusiness.html) NoncurrentDays (integer) --
Amplify (amplify.html) Specifies the number of days an object is noncurrent
APIGateway before Amazon S3 can perform the associated action. For
(apigateway.html) information about the noncurrent days calculations, see
How Amazon S3 Calculates When an Object Became
ApiGatewayManagement Noncurrent
Api (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-
(apigatewaymanagement lifecycle-rules.html#non-current-days-calculations) in the
api.html) Amazon Simple Storage Service Developer Guide.
Boto 3 Docs 1.9.249
documentation ( DaysAfterInitiation (integer) --
../../index.html) Specifies the number of days after which Amazon S3

aborts an incomplete multipart upload.
TABLE OF CONTENTS
Actions
Quickstart
of arguments set from identifiers and some attributes. For more information about
A Sample Tutorial (../../guide/resources.html#actions-intro).
delete ()
Code Examples
Deletes the lifecycle configuration from the bucket.
(../../guide/index.html) 01/DeleteBucketLifecycle)
Available Services (index.html) Request Syntax
ACM (acm.html)
ACMPCA (acm-pca.html) response = bucket_lifecycle.delete()
AlexaForBusiness
None
APIGateway
(apigateway.html) get_available_subresources ()
ApiGatewayManagement Returns a list of all the available sub-resources for this Resource.
Api
Returns
api.html)
Return type
Boto 3 Docs 1.9.249
list of str
documentation (
../../index.html)
load ()
TABLE OF CONTENTS Calls S3.Client.get_bucket_lifecycle() to update the attributes of the
BucketLifecycle resource. Note that the load and reload methods are the same
Quickstart method and can be used interchangeably.
A Sample Tutorial (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/None)
Request Syntax
Code Examples
bucket_lifecycle.load()
User Guides
Returns
ACM (acm.html)
ACMPCA (acm-pca.html) put (**kwargs)

AlexaForBusiness No longer used, see the PutBucketLifecycleConfiguration operation.
Amplify (amplify.html) Danger

APIGateway This operation is deprecated and may not function as expected. This
(apigateway.html) operation should not be used going forward and is only kept for the
Api
api.html)
Boto 3 Docs 1.9.249
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketLifecycle)
documentation (
Request Syntax
../../index.html)
TABLE OF CONTENTS
Quickstart
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = bucket_lifecycle.put(
documentation ( LifecycleConfiguration={
../../index.html) 'Rules': [
{
'Expiration': {
TABLE OF CONTENTS
'Days': 123,
Quickstart
},
A Sample Tutorial 'ID': 'string',
Code Examples 'Status': 'Enabled'|'Disabled',
(../../guide/examples.html) 'Transition': {
User Guides
'Days': 123,
'NoncurrentVersionTransition': {
ACM (acm.html)
ACMPCA (acm-pca.html) 'StorageClass': 'GLACIER'|'STANDARD_IA'|'ONEZONE_I
},
AlexaForBusiness
(alexaforbusiness.html) 'NoncurrentVersionExpiration': {
'NoncurrentDays': 123
APIGateway 'AbortIncompleteMultipartUpload': {
(apigateway.html) 'DaysAfterInitiation': 123
}
},
Api
]
api.html)
}
Boto 3 Docs 1.9.249
)
documentation (
../../index.html)
Parameters
TABLE OF CONTENTS
Quickstart (dict) --
(../../guide/quickstart.html) Specifies lifecycle rules for an Amazon S3 bucket. For more
A Sample Tutorial information, see PUT Bucket lifecycle
(../../guide/sqs.html) (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.h
Code Examples
(../../guide/examples.html) Expiration (dict) --
Date (datetime) --
User Guides Indicates at what date the object is to be moved or deleted. Should
(../../guide/index.html) be in GMT ISO 8601 Format.
Available Services (index.html) Days (integer) --

Indicates the lifetime, in days, of the objects that are subject to the
ACM (acm.html)
rule. The value must be a non-zero positive integer.
AlexaForBusiness Indicates whether Amazon S3 will remove a delete marker with no
(alexaforbusiness.html) noncurrent versions. If set to true, the delete marker will be
APIGateway
ID (string) --
(apigateway.html)
Unique identifier for the rule. The value can't be longer than 255
ApiGatewayManagement characters.
Api
api.html)
Object key prefix that identifies one or more objects to which this
Boto 3 Docs 1.9.249
rule applies.
documentation (
../../index.html)
If Enabled , the rule is currently being applied. If Disabled , the rule is
not currently being applied.
TABLE OF CONTENTS
Quickstart
Date (datetime) --
Indicates when objects are transitioned to the specified storage
A Sample Tutorial always midnight UTC.
Days (integer) --
Code Examples Indicates the number of days after creation when objects are
(../../guide/examples.html) transitioned to the specified storage class. The value must be a
positive integer.
User Guides
(../../guide/index.html) StorageClass (string) --
NoncurrentVersionTransition (dict) --
ACM (acm.html)
ACMPCA (acm-pca.html) Specifies the number of days an object is noncurrent before
AlexaForBusiness
Amplify (amplify.html) (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-
control.html) in the Amazon Simple Storage Service Developer Guide .
APIGateway
Api NoncurrentVersionExpiration (dict) --
(apigatewaymanagement NoncurrentDays (integer) --
api.html)
Boto 3 Docs 1.9.249
documentation ( about the noncurrent days calculations, see How Amazon S3
../../index.html) Calculates When an Object Became Noncurrent
TABLE OF CONTENTS lifecycle-rules.html#non-current-days-calculations) in the Amazon
Simple Storage Service Developer Guide.
Quickstart AbortIncompleteMultipartUpload (dict) --
(../../guide/quickstart.html) DaysAfterInitiation (integer) --
A Sample Tutorial Specifies the number of days after which Amazon S3 aborts an
(../../guide/sqs.html) incomplete multipart upload.

User Guides
(../../guide/index.html) reload ()
Available Services (index.html) Calls S3.Client.get_bucket_lifecycle() to update the attributes of the

BucketLifecycle resource. Note that the load and reload methods are the same
ACM (acm.html)
method and can be used interchangeably.
AlexaForBusiness (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/None)
Request Syntax
APIGateway bucket_lifecycle.reload()
(apigateway.html)
Api None
api.html)
Sub-resources
Boto 3 Docs 1.9.249
documentation ( resource's identifiers get passed along to the child. For more information about
../../index.html) sub-resources refer to the Resources Introduction Guide
(../../guide/resources.html#subresources-intro).
TABLE OF CONTENTS
Bucket ()
Quickstart
bucket = bucket_lifecycle.Bucket()
A Sample Tutorial

(../../guide/examples.html) S3.Bucket
User Guides Returns

(../../guide/index.html) A Bucket resource
BucketLifecycleConfiguration
ACM (acm.html)
AlexaForBusiness
(alexaforbusiness.html) class S3. BucketLifecycleConfiguration (bucket_name)
A resource representing an Amazon Simple Storage Service (S3)
BucketLifecycleConfiguration:
APIGateway
(apigateway.html)
Api
api.html)
documentation (
../../index.html) s3 = boto3.resource('s3')
bucket_lifecycle_configuration = s3.BucketLifecycleConfiguration('bucket_
TABLE OF CONTENTS
(../../guide/quickstart.html) bucket_name (string) -- The BucketLifecycleConfiguration's bucket_name
identifier. This must be set.
A Sample Tutorial
Code Examples
bucket_name
User Guides
(../../guide/index.html) rules

delete()
ACM (acm.html)
get_available_subresources()
ACMPCA (acm-pca.html) load()
AlexaForBusiness put()
(alexaforbusiness.html) reload()
Amplify (amplify.html) These are the resource's available sub-resources:
APIGateway Bucket()
(apigateway.html)
Identifiers
ApiGatewayManagement Identifiers are properties of a resource that are set upon instantation of the
Api resource. For more information about identifiers refer to the Resources
(apigatewaymanagement Introduction Guide (../../guide/resources.html#identifiers-attributes-intro).
api.html)
bucket_name
Boto 3 Docs 1.9.249
(string) The BucketLifecycleConfiguration's bucket_name identifier. This must be
documentation (
set.
../../index.html)
Attributes
TABLE OF CONTENTS Attributes provide access to the properties of a resource. Attributes are lazy-loaded
Quickstart attributes refer to the Resources Introduction Guide
(../../guide/quickstart.html) (../../guide/resources.html#identifiers-attributes-intro).
A Sample Tutorial rules

(../../guide/sqs.html) (list) --
User Guides
Date (datetime) --
Indicates at what date the object is to be moved or
Available Services (index.html) deleted. Should be in GMT ISO 8601 Format.
ACM (acm.html) Days (integer) --
ACMPCA (acm-pca.html) Indicates the lifetime, in days, of the objects that are
AlexaForBusiness subject to the rule. The value must be a non-zero positive
(alexaforbusiness.html) integer.
Amplify (amplify.html) ExpiredObjectDeleteMarker (boolean) --
APIGateway Indicates whether Amazon S3 will remove a delete marker

(apigateway.html) with no noncurrent versions. If set to true, the delete
marker will be expired; if set to false the policy takes no
ApiGatewayManagement action. This cannot be specified with Days or Date in a
Api Lifecycle Expiration Policy.
api.html) ID (string) --
Unique identifier for the rule. The value cannot be longer than
Boto 3 Docs 1.9.249
255 characters.
documentation (
Prefix (string) --
../../index.html)
TABLE OF CONTENTS This is No longer used; use Filter instead.
Filter (dict) --
Quickstart
Prefix (string) --
Prefix identifying one or more objects to which the rule
A Sample Tutorial
applies.
Tag (dict) --
Code Examples
(../../guide/examples.html) This tag must exist in the object's tag set in order for the
rule to apply.
User Guides
(../../guide/index.html) Key (string) --
Name of the tag.
Value (string) --
ACM (acm.html)
Value of the tag.
And (dict) --
AlexaForBusiness
(alexaforbusiness.html) Prefix (string) --
Amplify (amplify.html) Tags (list) --
APIGateway All of these tags must exist in the object's tag set in
(apigateway.html) order for the rule to apply.
ApiGatewayManagement (dict) --
Api
Key (string) --
api.html) Name of the tag.
Value (string) --
Boto 3 Docs 1.9.249
documentation ( Value of the tag.
../../index.html) Status (string) --

If 'Enabled', the rule is currently being applied. If 'Disabled', the
TABLE OF CONTENTS rule is not currently being applied.
Quickstart
A Sample Tutorial Specifies when an object transitions to a specified storage

(../../guide/sqs.html) class.
Code Examples Date (datetime) --

Indicates when objects are transitioned to the
User Guides specified storage class. The date value must be in
(../../guide/index.html) ISO 8601 format. The time is always midnight UTC.
Days (integer) --
Indicates the number of days after creation when
ACM (acm.html)
objects are transitioned to the specified storage
ACMPCA (acm-pca.html) class. The value must be a positive integer.
The storage class to which you want the object to
Amplify (amplify.html) transition.
APIGateway NoncurrentVersionTransitions (list) --
(apigateway.html)
(dict) --
Container for the transition rule that describes when
Api
noncurrent objects transition to the STANDARD_IA ,
ONEZONE_IA , INTELLIGENT_TIERING , GLACIER , or
api.html)
DEEP_ARCHIVE storage class. If your bucket is versioning-
Boto 3 Docs 1.9.249
enabled (or versioning is suspended), you can set this
documentation ( action to request that Amazon S3 transition noncurrent
../../index.html) object versions to the STANDARD_IA , ONEZONE_IA ,
INTELLIGENT_TIERING , GLACIER , or DEEP_ARCHIVE storage
TABLE OF CONTENTS class at a specific period in the object's lifetime.
Quickstart
(../../guide/quickstart.html) Specifies the number of days an object is noncurrent
before Amazon S3 can perform the associated
A Sample Tutorial action. For information about the noncurrent days
(../../guide/sqs.html) calculations, see How Amazon S3 Calculates When
Code Examples an Object Became Noncurrent
(../../guide/examples.html) (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-
access-control.html) in the Amazon Simple Storage
User Guides Service Developer Guide .
ACM (acm.html)
AlexaForBusiness
Specifies the number of days an object is noncurrent
before Amazon S3 can perform the associated action. For
Amplify (amplify.html) information about the noncurrent days calculations, see
How Amazon S3 Calculates When an Object Became
APIGateway
Noncurrent
(apigateway.html)
ApiGatewayManagement lifecycle-rules.html#non-current-days-calculations) in the
Api Amazon Simple Storage Service Developer Guide.
api.html)
Boto 3 Docs 1.9.249
documentation ( Specifies the number of days after which Amazon S3
aborts an incomplete multipart upload.
../../index.html)
Actions
TABLE OF CONTENTS Actions call operations on resources. They may automatically handle the passing in
Quickstart actions refer to the Resources Introduction Guide
(../../guide/quickstart.html) (../../guide/resources.html#actions-intro).
A Sample Tutorial delete ()
Deletes the lifecycle configuration from the bucket.
Code Examples
User Guides 01/DeleteBucketLifecycle)
ACM (acm.html) response = bucket_lifecycle_configuration.delete()
Returns
AlexaForBusiness
None
APIGateway get_available_subresources ()
(apigateway.html) Returns a list of all the available sub-resources for this Resource.
Api A list containing the name of each sub-resource for this resource
Return type
api.html)
list of str
Boto 3 Docs 1.9.249
documentation (
../../index.html) load ()
Calls S3.Client.get_bucket_lifecycle_configuration() to update the
TABLE OF CONTENTS attributes of the BucketLifecycleConfiguration resource. Note that the load and
reload methods are the same method and can be used interchangeably.
Quickstart
A Sample Tutorial
Request Syntax
Code Examples
bucket_lifecycle_configuration.load()
User Guides
Returns
None
ACM (acm.html)
put (**kwargs)
ACMPCA (acm-pca.html) Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it
AlexaForBusiness replaces it.
Amplify (amplify.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-
01/PutBucketLifecycleConfiguration)
APIGateway
(apigateway.html) Request Syntax
Api
api.html)
Boto 3 Docs 1.9.249 response = bucket_lifecycle_configuration.put(
documentation ( LifecycleConfiguration={
../../index.html) 'Rules': [
{
'Expiration': {
TABLE OF CONTENTS
'Days': 123,
Quickstart
},
A Sample Tutorial 'ID': 'string',
Code Examples 'Filter': {
'Tag': {
User Guides
'Key': 'string',
'Value': 'string'
'And': {
ACM (acm.html)
'Prefix': 'string',
ACMPCA (acm-pca.html) 'Tags': [
{
AlexaForBusiness
(alexaforbusiness.html) 'Key': 'string',
'Value': 'string'
APIGateway ]
(apigateway.html) }
},
Api
'Transitions': [
api.html) {
Boto 3 Docs 1.9.249
'Days': 123,
documentation ( 'StorageClass': 'GLACIER'|'STANDARD_IA'|'ONEZO
../../index.html) },
],
TABLE OF CONTENTS 'NoncurrentVersionTransitions': [
{
Quickstart 'NoncurrentDays': 123,
(../../guide/quickstart.html) 'StorageClass': 'GLACIER'|'STANDARD_IA'|'ONEZO
},
A Sample Tutorial
],
Code Examples 'NoncurrentDays': 123
User Guides 'AbortIncompleteMultipartUpload': {
(../../guide/index.html) 'DaysAfterInitiation': 123
}
ACM (acm.html) ]
}
)
AlexaForBusiness

APIGateway
(apigateway.html)
A lifecycle rule for individual objects in an Amazon S3 bucket.
(dict) --
Api
Date (datetime) --
api.html)
Indicates at what date the object is to be moved or deleted. Should
Boto 3 Docs 1.9.249
be in GMT ISO 8601 Format.
documentation (
Days (integer) --
../../index.html)
Indicates the lifetime, in days, of the objects that are subject to the
rule. The value must be a non-zero positive integer.
TABLE OF CONTENTS
Indicates whether Amazon S3 will remove a delete marker with no
Quickstart
noncurrent versions. If set to true, the delete marker will be
A Sample Tutorial specified with Days or Date in a Lifecycle Expiration Policy.
ID (string) --
Code Examples Unique identifier for the rule. The value cannot be longer than 255
(../../guide/examples.html) characters.
User Guides Prefix (string) --

(../../guide/index.html) Prefix identifying one or more objects to which the rule applies. This
is No longer used; use Filter instead.
Filter (dict) --
ACM (acm.html) Prefix (string) --
ACMPCA (acm-pca.html) Prefix identifying one or more objects to which the rule applies.
AlexaForBusiness Tag (dict) --

(alexaforbusiness.html) This tag must exist in the object's tag set in order for the rule to
apply.
APIGateway
Name of the tag.
(apigateway.html)
Value of the tag.
Api
(apigatewaymanagement And (dict) --
api.html) Prefix (string) --
Tags (list) --
Boto 3 Docs 1.9.249
All of these tags must exist in the object's tag set in order for the
documentation ( rule to apply.
../../index.html)
(dict) --
TABLE OF CONTENTS Name of the tag.
Quickstart
Value of the tag.
A Sample Tutorial
If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is
not currently being applied.
Code Examples
(dict) --
User Guides Specifies when an object transitions to a specified storage class.
Date (datetime) --
Available Services (index.html) Indicates when objects are transitioned to the specified storage
ACM (acm.html) always midnight UTC.
ACMPCA (acm-pca.html) Days (integer) --
AlexaForBusiness Indicates the number of days after creation when objects are
(alexaforbusiness.html) transitioned to the specified storage class. The value must be a
positive integer.
APIGateway
(apigateway.html)
NoncurrentVersionTransitions (list) --
(dict) --
Api
api.html)
Boto 3 Docs 1.9.249
documentation ( INTELLIGENT_TIERING , GLACIER , or DEEP_ARCHIVE storage class. If
../../index.html) your bucket is versioning-enabled (or versioning is suspended), you
can set this action to request that Amazon S3 transition noncurrent
TABLE OF CONTENTS object versions to the STANDARD_IA , ONEZONE_IA ,
INTELLIGENT_TIERING , GLACIER , or DEEP_ARCHIVE storage class at
Quickstart a specific period in the object's lifetime.
(../../guide/quickstart.html) NoncurrentDays (integer) --
A Sample Tutorial Specifies the number of days an object is noncurrent before
(../../guide/sqs.html) Amazon S3 can perform the associated action. For information
Code Examples
(https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-
User Guides control.html) in the Amazon Simple Storage Service Developer
(../../guide/index.html) Guide .
ACM (acm.html)
ACMPCA (acm-pca.html) NoncurrentDays (integer) --
AlexaForBusiness Specifies the number of days an object is noncurrent before
(alexaforbusiness.html) Amazon S3 can perform the associated action. For information
Amplify (amplify.html) Calculates When an Object Became Noncurrent
APIGateway (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-
(apigateway.html) lifecycle-rules.html#non-current-days-calculations) in the Amazon
Simple Storage Service Developer Guide.
Api AbortIncompleteMultipartUpload (dict) --
(apigatewaymanagement DaysAfterInitiation (integer) --
api.html)
Specifies the number of days after which Amazon S3 aborts an
Boto 3 Docs 1.9.249
documentation (
Returns
../../index.html)
None
TABLE OF CONTENTS
reload ()
Quickstart
Calls S3.Client.get_bucket_lifecycle_configuration() to update the
attributes of the BucketLifecycleConfiguration resource. Note that the load and
A Sample Tutorial reload methods are the same method and can be used interchangeably.
Code Examples (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/None)
Request Syntax
User Guides
bucket_lifecycle_configuration.reload()

None
AlexaForBusiness
(alexaforbusiness.html) Sub-resources
Amplify (amplify.html) Sub-resources are methods that create a new instance of a child resource. This
resource's identifiers get passed along to the child. For more information about
APIGateway sub-resources refer to the Resources Introduction Guide
(apigateway.html) (../../guide/resources.html#subresources-intro).
Bucket ()
Api
api.html)
Boto 3 Docs 1.9.249 bucket = bucket_lifecycle_configuration.Bucket()
documentation (
S3.Bucket
TABLE OF CONTENTS
Returns
Quickstart A Bucket resource

A Sample Tutorial
BucketLogging
Code Examples
class S3. BucketLogging (bucket_name)
User Guides A resource representing an Amazon Simple Storage Service (S3) BucketLogging:
Available Services (index.html) import boto3
ACM (acm.html)
ACMPCA (acm-pca.html) bucket_logging = s3.BucketLogging('bucket_name')
AlexaForBusiness
Parameters
Amplify (amplify.html) bucket_name (string) -- The BucketLogging's bucket_name identifier. This must
be set.
APIGateway
(apigateway.html)
bucket_name
Api
(apigatewaymanagement These are the resource's available attributes:
api.html)
logging_enabled
Boto 3 Docs 1.9.249
documentation ( These are the resource's available actions:
../../index.html) get_available_subresources()
load()
TABLE OF CONTENTS put()
reload()
Quickstart These are the resource's available sub-resources:
Bucket()
A Sample Tutorial
(../../guide/sqs.html) Identifiers
Code Examples
User Guides bucket_name
(string) The BucketLogging's bucket_name identifier. This must be set.
Attributes
ACM (acm.html) Attributes provide access to the properties of a resource. Attributes are lazy-loaded
ACMPCA (acm-pca.html) the first time one is accessed via the load() method. For more information about
AlexaForBusiness
logging_enabled
(dict) --
APIGateway
(apigateway.html)
TargetBucket (string) --
Api
own, including the same bucket that is being logged. You can also
api.html)
configure multiple buckets to deliver their logs to the same target
Boto 3 Docs 1.9.249
each source bucket so that the delivered log files can be
documentation ( distinguished by key.
../../index.html)
TargetGrants (list) --
Grantee (dict) --
Quickstart
A Sample Tutorial
(../../guide/sqs.html) EmailAddress (string) --
Code Examples Email address of the grantee.

ID (string) --
User Guides The canonical user ID of the grantee.
Type (string) --
Type of grantee
ACM (acm.html)
URI (string) --
AlexaForBusiness
Logging permissions assigned to the Grantee for the
bucket.
APIGateway
TargetPrefix (string) --
(apigateway.html)
Api
distinguish which log files came from which bucket.
api.html)
Actions
Boto 3 Docs 1.9.249
documentation ( actions refer to the Resources Introduction Guide
../../index.html) (../../guide/resources.html#actions-intro).
get_available_subresources ()
TABLE OF CONTENTS
Quickstart Returns
(../../guide/quickstart.html) A list containing the name of each sub-resource for this resource
(../../guide/sqs.html) list of str
Code Examples
load ()
User Guides
Calls S3.Client.get_bucket_logging() to update the attributes of the
BucketLogging resource. Note that the load and reload methods are the same
Available Services (index.html) method and can be used interchangeably.

Request Syntax
AlexaForBusiness
bucket_logging.load()
APIGateway
Returns
(apigateway.html)
None
Api
(apigatewaymanagement put (**kwargs)
api.html)
Set the logging parameters for a bucket and to specify permissions for who can
Boto 3 Docs 1.9.249
view and modify the logging parameters. To set the logging status of a bucket,
documentation ( you must be the bucket owner.
../../index.html)
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketLogging)
TABLE OF CONTENTS
Request Syntax
Quickstart
(../../guide/quickstart.html) response = bucket_logging.put(
A Sample Tutorial BucketLoggingStatus={
(../../guide/sqs.html) 'LoggingEnabled': {
'TargetBucket': 'string',
Code Examples
'TargetGrants': [
{
User Guides 'Grantee': {
(../../guide/index.html) 'DisplayName': 'string',
Available Services (index.html) 'ID': 'string',
ACM (acm.html) 'Type': 'CanonicalUser'|'AmazonCustomerByEmail
'URI': 'string'
},
AlexaForBusiness 'Permission': 'FULL_CONTROL'|'READ'|'WRITE'
APIGateway
}
(apigateway.html)
},
Api )
api.html)
Parameters
Boto 3 Docs 1.9.249
BucketLoggingStatus (dict) --
../../index.html)
LoggingEnabled (dict) --
TargetBucket (string) -- [REQUIRED]
TABLE OF CONTENTS
Specifies the bucket where you want Amazon S3 to store server access
logs. You can have your logs delivered to any bucket that you own,
Quickstart including the same bucket that is being logged. You can also configure
(../../guide/quickstart.html) multiple buckets to deliver their logs to the same target bucket. In this
A Sample Tutorial case you should choose a different TargetPrefix for each source bucket
(../../guide/sqs.html) so that the delivered log files can be distinguished by key.
Code Examples TargetGrants (list) --

(../../guide/examples.html) (dict) --
Grantee (dict) --
User Guides DisplayName (string) --
(../../guide/index.html) Screen name of the grantee.
Available Services (index.html) EmailAddress (string) --

ACM (acm.html)
ID (string) --
AlexaForBusiness
Type of grantee
URI (string) --
APIGateway URI of the grantee group.
(apigateway.html)
ApiGatewayManagement Logging permissions assigned to the Grantee for the bucket.
Api
TargetPrefix (string) -- [REQUIRED]
api.html)
Boto 3 Docs 1.9.249
documentation ( distinguish which log files came from which bucket.
../../index.html)
Returns
None
TABLE OF CONTENTS
Quickstart reload ()
Calls S3.Client.get_bucket_logging() to update the attributes of the
A Sample Tutorial BucketLogging resource. Note that the load and reload methods are the same
(../../guide/sqs.html) method and can be used interchangeably.
(../../guide/examples.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/None)

Available Services (index.html) bucket_logging.reload()
ACM (acm.html)
Returns
None
AlexaForBusiness
Sub-resources
APIGateway resource's identifiers get passed along to the child. For more information about
(apigateway.html) sub-resources refer to the Resources Introduction Guide
ApiGatewayManagement (../../guide/resources.html#subresources-intro).
Api
Bucket ()
api.html)
Boto 3 Docs 1.9.249 bucket = bucket_logging.Bucket()
documentation (
S3.Bucket
TABLE OF CONTENTS
Returns
A Sample Tutorial
BucketNotification
Code Examples
class S3. BucketNotification (bucket_name)
User Guides A resource representing an Amazon Simple Storage Service (S3) BucketNotification:
Available Services (index.html) import boto3
ACM (acm.html)
ACMPCA (acm-pca.html) bucket_notification = s3.BucketNotification('bucket_name')
AlexaForBusiness
Parameters
Amplify (amplify.html) bucket_name (string) -- The BucketNotification's bucket_name identifier. This
must be set.
APIGateway
(apigateway.html)
bucket_name
Api
(apigatewaymanagement These are the resource's available attributes:
api.html)
lambda_function_configurations
Boto 3 Docs 1.9.249
queue_configurations
documentation ( topic_configurations
../../index.html)

load()
Quickstart put()

Bucket()
Code Examples
Identifiers

(string) The BucketNotification's bucket_name identifier. This must be set.
ACM (acm.html)
ACMPCA (acm-pca.html) Attributes

AlexaForBusiness
Amplify (amplify.html) (../../guide/resources.html#identifiers-attributes-intro).
APIGateway lambda_function_configurations
(apigateway.html) (list) --
ApiGatewayManagement Describes the AWS Lambda functions to invoke and the events for which
Api to invoke them.
api.html) (dict) --
Boto 3 Docs 1.9.249
notifications.
documentation (
Id (string) --
../../index.html)
TABLE OF CONTENTS configuration. If you don't provide one, Amazon S3 will assign
an ID.
Quickstart LambdaFunctionArn (string) --
The Amazon Resource Name (ARN) of the AWS Lambda
A Sample Tutorial function that Amazon S3 invokes when the specified event type
(../../guide/sqs.html) occurs.
Code Examples Events (list) --
The Amazon S3 bucket event for which to invoke the AWS
User Guides Lambda function. For more information, see Supported Event
(../../guide/index.html) Types
(https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowT
Available Services (index.html) in the Amazon Simple Storage Service Developer Guide .
ACMPCA (acm-pca.html) The bucket event for which to send notifications.
AlexaForBusiness Filter (dict) --
Key (dict) --
APIGateway
ApiGatewayManagement Specifies the Amazon S3 object key name to

Api filter on and whether to filter on the suffix or
(apigatewaymanagement prefix of the key name.
api.html) Name (string) --
The object key name prefix or suffix
Boto 3 Docs 1.9.249
identifying one or more objects to which
documentation ( the filtering rule applies. The maximum
../../index.html) length is 1,024 characters. Overlapping
prefixes and suffixes are not supported.
TABLE OF CONTENTS For more information, see Configuring
Event Notifications
Quickstart (https://docs.aws.amazon.com/AmazonS3/latest/
(../../guide/quickstart.html) in the Amazon Simple Storage Service
Developer Guide .
A Sample Tutorial
Code Examples The value that the filter searches for in

(../../guide/examples.html) object key names.
User Guides queue_configurations

(../../guide/index.html) (list) --
Available Services (index.html) The Amazon Simple Queue Service queues to publish messages to and the
events for which to publish messages.
ACM (acm.html)
(dict) --
AlexaForBusiness
specified events.
Id (string) --
APIGateway
(apigateway.html)
configuration. If you don't provide one, Amazon S3 will assign
ApiGatewayManagement an ID.
Api
QueueArn (string) --
api.html)
The Amazon Resource Name (ARN) of the Amazon SQS queue
Boto 3 Docs 1.9.249
to which Amazon S3 publishes a message when it detects
documentation ( events of the specified type.
../../index.html)
Events (list) --
TABLE OF CONTENTS (string) --

Quickstart
Filter (dict) --
Key (dict) --
A Sample Tutorial
(../../guide/sqs.html) FilterRules (list) --

Specifies the Amazon S3 object key name to
User Guides filter on and whether to filter on the suffix or
(../../guide/index.html) prefix of the key name.
Name (string) --
ACM (acm.html)
identifying one or more objects to which
ACMPCA (acm-pca.html) the filtering rule applies. The maximum
AlexaForBusiness length is 1,024 characters. Overlapping
(alexaforbusiness.html) prefixes and suffixes are not supported.
For more information, see Configuring
Amplify (amplify.html) Event Notifications
APIGateway (https://docs.aws.amazon.com/AmazonS3/latest/
(apigateway.html) in the Amazon Simple Storage Service
Developer Guide .
Api Value (string) --
(apigatewaymanagement The value that the filter searches for in
api.html) object key names.
topic_configurations
Boto 3 Docs 1.9.249
(list) --
documentation (
../../index.html) The topic to which notifications are sent and the events for which
A container for specifying the configuration for publication of

Quickstart messages to an Amazon Simple Notification Service (Amazon SNS)
(../../guide/quickstart.html) topic when Amazon S3 detects specified events.
A Sample Tutorial Id (string) --
Code Examples configuration. If you don't provide one, Amazon S3 will assign
(../../guide/examples.html) an ID.
User Guides TopicArn (string) --
Available Services (index.html) which Amazon S3 publishes a message when it detects events
of the specified type.
ACM (acm.html)
Events (list) --
The Amazon S3 bucket event about which to send notifications.
AlexaForBusiness
For more information, see Supported Event Types
(https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowT
Amplify (amplify.html) in the Amazon Simple Storage Service Developer Guide .
APIGateway (string) --
(apigateway.html)
Filter (dict) --
Api
(apigatewaymanagement Key (dict) --
api.html) FilterRules (list) --
(dict) --
Boto 3 Docs 1.9.249
documentation ( Specifies the Amazon S3 object key name to
filter on and whether to filter on the suffix or
../../index.html)
prefix of the key name.
TABLE OF CONTENTS Name (string) --

Quickstart identifying one or more objects to which
(../../guide/quickstart.html) the filtering rule applies. The maximum
length is 1,024 characters. Overlapping
A Sample Tutorial
prefixes and suffixes are not supported.
For more information, see Configuring
Code Examples Event Notifications
(../../guide/examples.html) (https://docs.aws.amazon.com/AmazonS3/latest/
in the Amazon Simple Storage Service
User Guides
Developer Guide .
Value (string) --
The value that the filter searches for in
ACM (acm.html) object key names.
Actions
AlexaForBusiness
Amplify (amplify.html) actions refer to the Resources Introduction Guide
APIGateway
(apigateway.html) get_available_subresources ()
ApiGatewayManagement Returns a list of all the available sub-resources for this Resource.
Api Returns
api.html)
Return type
Boto 3 Docs 1.9.249
list of str
documentation (
../../index.html)
load ()
TABLE OF CONTENTS Calls S3.Client.get_bucket_notification_configuration() to update the
attributes of the BucketNotification resource. Note that the load and reload
Quickstart methods are the same method and can be used interchangeably.
A Sample Tutorial (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/None)
Request Syntax
Code Examples
bucket_notification.load()
User Guides
Returns
ACM (acm.html)
ACMPCA (acm-pca.html) put (**kwargs)

AlexaForBusiness Enables notifications of specified events for a bucket.
01/PutBucketNotificationConfiguration)
APIGateway
Api
api.html)
Boto 3 Docs 1.9.249 response = bucket_notification.put(
documentation ( NotificationConfiguration={
../../index.html) 'TopicConfigurations': [
{
'Id': 'string',
TABLE OF CONTENTS
'Events': [
Quickstart
],
A Sample Tutorial 'Filter': {
(../../guide/sqs.html) 'Key': {
Code Examples 'FilterRules': [
User Guides
'Value': 'string'
},
}
ACM (acm.html)
}
],
AlexaForBusiness
(alexaforbusiness.html) 'QueueConfigurations': [
{
Amplify (amplify.html) 'Id': 'string',
APIGateway 'QueueArn': 'string',
(apigateway.html) 'Events': [
],
Api
'Filter': {
api.html) 'Key': {
'FilterRules': [
Boto 3 Docs 1.9.249
{
documentation ( 'Name': 'prefix'|'suffix',
../../index.html) 'Value': 'string'
},
TABLE OF CONTENTS ]
}
Quickstart }
],
A Sample Tutorial
{
Code Examples 'Id': 'string',
(../../guide/examples.html) 'LambdaFunctionArn': 'string',
User Guides 'Events': [
(../../guide/index.html) 's3:ReducedRedundancyLostObject'|'s3:ObjectCreated
],
Available Services (index.html) 'Filter': {
ACM (acm.html) 'Key': {
'FilterRules': [
{
AlexaForBusiness 'Name': 'prefix'|'suffix',
(alexaforbusiness.html) 'Value': 'string'
]
APIGateway }
(apigateway.html)
}
ApiGatewayManagement },
Api ]
(apigatewaymanagement }
api.html) )
Boto 3 Docs 1.9.249
documentation (
Parameters
../../index.html) NotificationConfiguration (dict) --
[REQUIRED]
TABLE OF CONTENTS
TopicConfigurations (list) --
The topic to which notifications are sent and the events for which
Quickstart
(dict) --
A Sample Tutorial
A container for specifying the configuration for publication of messages
to an Amazon Simple Notification Service (Amazon SNS) topic when
Code Examples Amazon S3 detects specified events.
Id (string) --
User Guides An optional unique identifier for configurations in a notification
(../../guide/index.html) configuration. If you don't provide one, Amazon S3 will assign an ID.
TopicArn (string) -- [REQUIRED]

The Amazon Resource Name (ARN) of the Amazon SNS topic to which
ACM (acm.html) Amazon S3 publishes a message when it detects events of the
ACMPCA (acm-pca.html) specified type.
AlexaForBusiness Events (list) -- [REQUIRED]

(alexaforbusiness.html) The Amazon S3 bucket event about which to send notifications. For
Amplify (amplify.html) (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.htm
APIGateway in the Amazon Simple Storage Service Developer Guide .
(apigateway.html) (string) --
ApiGatewayManagement The bucket event for which to send notifications.
Api Filter (dict) --
(apigatewaymanagement Key (dict) --
api.html) FilterRules (list) --
(dict) --
Boto 3 Docs 1.9.249
Specifies the Amazon S3 object key name to filter on and
documentation ( whether to filter on the suffix or prefix of the key name.
../../index.html)
Name (string) --
The object key name prefix or suffix identifying one or more
TABLE OF CONTENTS objects to which the filtering rule applies. The maximum
length is 1,024 characters. Overlapping prefixes and suffixes
Quickstart are not supported. For more information, see Configuring
(../../guide/quickstart.html) Event Notifications
A Sample Tutorial (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHo
(../../guide/sqs.html) in the Amazon Simple Storage Service Developer Guide .
Code Examples Value (string) --

(../../guide/examples.html) The value that the filter searches for in object key names.
QueueConfigurations (list) --
User Guides
the events for which to publish messages.
ACM (acm.html) Specifies the configuration for publishing messages to an Amazon
specified events.
AlexaForBusiness
Id (string) --
Amplify (amplify.html) configuration. If you don't provide one, Amazon S3 will assign an ID.
APIGateway QueueArn (string) -- [REQUIRED]

(apigateway.html) The Amazon Resource Name (ARN) of the Amazon SQS queue to
which Amazon S3 publishes a message when it detects events of the
specified type.
Api
(apigatewaymanagement Events (list) -- [REQUIRED]
Boto 3 Docs 1.9.249
Key (dict) --
../../index.html)
(dict) --
TABLE OF CONTENTS Specifies the Amazon S3 object key name to filter on and
Quickstart
Name (string) --
A Sample Tutorial objects to which the filtering rule applies. The maximum
(../../guide/sqs.html) length is 1,024 characters. Overlapping prefixes and suffixes
Code Examples are not supported. For more information, see Configuring
(../../guide/examples.html) Event Notifications
(https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHo
User Guides in the Amazon Simple Storage Service Developer Guide .
Value (string) --
Available Services (index.html) The value that the filter searches for in object key names.
ACM (acm.html) LambdaFunctionConfigurations (list) --

Describes the AWS Lambda functions to invoke and the events for which
to invoke them.
AlexaForBusiness
(dict) --
Amplify (amplify.html) notifications.
APIGateway Id (string) --
(apigateway.html) An optional unique identifier for configurations in a notification
Api LambdaFunctionArn (string) -- [REQUIRED]
(apigatewaymanagement The Amazon Resource Name (ARN) of the AWS Lambda function that
api.html) Amazon S3 invokes when the specified event type occurs.
Boto 3 Docs 1.9.249
documentation ( function. For more information, see Supported Event Types
../../index.html) (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.htm
Quickstart
Filter (dict) --
Key (dict) --
A Sample Tutorial FilterRules (list) --
(../../guide/sqs.html) (dict) --
Code Examples Specifies the Amazon S3 object key name to filter on and
(../../guide/examples.html) whether to filter on the suffix or prefix of the key name.
Name (string) --
User Guides
objects to which the filtering rule applies. The maximum
Available Services (index.html) length is 1,024 characters. Overlapping prefixes and suffixes
are not supported. For more information, see Configuring
ACM (acm.html)
Event Notifications
ACMPCA (acm-pca.html) (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHo
AlexaForBusiness
(alexaforbusiness.html) Value (string) --
Returns
APIGateway
(apigateway.html)
None
Api reload ()
api.html)
Calls S3.Client.get_bucket_notification_configuration() to update the
Boto 3 Docs 1.9.249
attributes of the BucketNotification resource. Note that the load and reload
documentation ( methods are the same method and can be used interchangeably.
../../index.html)
TABLE OF CONTENTS
Request Syntax
Quickstart
(../../guide/quickstart.html) bucket_notification.reload()
A Sample Tutorial
Code Examples None
User Guides Sub-resources

Available Services (index.html) resource's identifiers get passed along to the child. For more information about
ACM (acm.html) (../../guide/resources.html#subresources-intro).
Bucket ()
AlexaForBusiness Creates a Bucket resource.:
Amplify (amplify.html) bucket = bucket_notification.Bucket()

APIGateway
(apigateway.html)
Return type
ApiGatewayManagement S3.Bucket
Api
Returns
api.html) A Bucket resource
Boto 3 Docs 1.9.249
documentation (
../../index.html)
BucketPolicy
TABLE OF CONTENTS class S3. BucketPolicy (bucket_name)
A resource representing an Amazon Simple Storage Service (S3) BucketPolicy:
Quickstart
import boto3
A Sample Tutorial
(../../guide/sqs.html) s3 = boto3.resource('s3')
Code Examples bucket_policy = s3.BucketPolicy('bucket_name')


(../../guide/index.html) bucket_name (string) -- The BucketPolicy's bucket_name identifier. This must
be set.
ACM (acm.html)
bucket_name
AlexaForBusiness These are the resource's available attributes:

(alexaforbusiness.html) policy
Amplify (amplify.html) These are the resource's available actions:
APIGateway delete()
(apigateway.html) get_available_subresources()
ApiGatewayManagement load()
Api put()
(apigatewaymanagement reload()
api.html)
Boto 3 Docs 1.9.249
(string) The BucketPolicy's bucket_name identifier. This must be set.
A Sample Tutorial
Code Examples
(../../guide/index.html) policy
Available Services (index.html) (string) --
ACM (acm.html) The bucket policy as a JSON document.
ACMPCA (acm-pca.html) Actions

AlexaForBusiness Actions call operations on resources. They may automatically handle the passing in
(alexaforbusiness.html) of arguments set from identifiers and some attributes. For more information about
APIGateway
(apigateway.html) delete ()
Deletes the policy from the bucket.
Api See also: AWS API Documentation
(apigatewaymanagement (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketPolicy)
Boto 3 Docs 1.9.249 response = bucket_policy.delete()
documentation (
None
TABLE OF CONTENTS
Quickstart get_available_subresources ()
(../../guide/quickstart.html) Returns a list of all the available sub-resources for this Resource.
Code Examples
Return type
list of str
User Guides
load ()
Calls S3.Client.get_bucket_policy() to update the attributes of the
ACM (acm.html) BucketPolicy resource. Note that the load and reload methods are the same
AlexaForBusiness
Request Syntax
APIGateway
(apigateway.html) bucket_policy.load()
Api Returns
(apigatewaymanagement None
api.html)
Boto 3 Docs 1.9.249 put (**kwargs)
Applies an Amazon S3 bucket policy to an Amazon S3 bucket.
documentation (
../../index.html) See also: AWS API Documentation
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketPolicy)
Quickstart
response = bucket_policy.put(
ConfirmRemoveSelfBucketAccess=True|False,
A Sample Tutorial Policy='string'
Code Examples
User Guides ConfirmRemoveSelfBucketAccess (boolean) -- Set this parameter to
(../../guide/index.html) true to confirm that you want to remove your permissions to change this
bucket policy in the future.
Available Services (index.html) Policy (string) --
ACMPCA (acm-pca.html) The bucket policy as a JSON document.
APIGateway reload ()
(apigateway.html) Calls S3.Client.get_bucket_policy() to update the attributes of the
ApiGatewayManagement BucketPolicy resource. Note that the load and reload methods are the same
Api method and can be used interchangeably.
api.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/None)
Request Syntax
Boto 3 Docs 1.9.249
documentation (
bucket_policy.reload()
../../index.html)

None
Quickstart
Sub-resources
A Sample Tutorial
Code Examples sub-resources refer to the Resources Introduction Guide
(../../guide/examples.html) (../../guide/resources.html#subresources-intro).
User Guides Bucket ()

(../../guide/index.html) Creates a Bucket resource.:

bucket = bucket_policy.Bucket()
ACM (acm.html)
Return type
AlexaForBusiness
S3.Bucket
Returns
A Bucket resource
APIGateway
(apigateway.html)
Api BucketRequestPayment
api.html)
Boto 3 Docs 1.9.249 class S3. BucketRequestPayment (bucket_name)
documentation ( A resource representing an Amazon Simple Storage Service (S3)

BucketRequestPayment:
../../index.html)
TABLE OF CONTENTS import boto3
Quickstart
(../../guide/quickstart.html) bucket_request_payment = s3.BucketRequestPayment('bucket_name')
A Sample Tutorial
bucket_name (string) -- The BucketRequestPayment's bucket_name identifier.
Code Examples
This must be set.
User Guides These are the resource's available identifiers:

(../../guide/index.html) bucket_name
Available Services (index.html) These are the resource's available attributes:
ACM (acm.html) payer
ACMPCA (acm-pca.html) These are the resource's available actions:
AlexaForBusiness get_available_subresources()
(alexaforbusiness.html) load()
Amplify (amplify.html) put()
reload()
APIGateway
(apigateway.html) These are the resource's available sub-resources:
ApiGatewayManagement Bucket()
Api
Identifiers
api.html)
Boto 3 Docs 1.9.249
../../index.html)
bucket_name
(string) The BucketRequestPayment's bucket_name identifier. This must be set.
TABLE OF CONTENTS
Attributes
Code Examples payer

(../../guide/examples.html) (string) --
User Guides Specifies who pays for the download and request fees.
Actions
Available Services (index.html) Actions call operations on resources. They may automatically handle the passing in
ACM (acm.html) of arguments set from identifiers and some attributes. For more information about
AlexaForBusiness
Returns
APIGateway
(apigateway.html)
Return type
list of str
Api
api.html)
Boto 3 Docs 1.9.249 load ()
Calls S3.Client.get_bucket_request_payment() to update the attributes of the
documentation (
BucketRequestPayment resource. Note that the load and reload methods are
../../index.html)
the same method and can be used interchangeably.
TABLE OF CONTENTS

A Sample Tutorial bucket_request_payment.load()


None
User Guides
put (**kwargs)
Available Services (index.html) Sets the request payment configuration for a bucket. By default, the bucket
ACM (acm.html) owner pays for downloads from the bucket. This configuration parameter
enables the bucket owner (only) to specify that the person requesting the
download will be charged for the download. Documentation on requester pays
AlexaForBusiness buckets can be found at
(alexaforbusiness.html) http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html
(http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html)
APIGateway
(apigateway.html)
01/PutBucketRequestPayment)
Request Syntax
Api
api.html)
Boto 3 Docs 1.9.249 response = bucket_request_payment.put(
documentation ( RequestPaymentConfiguration={
../../index.html) 'Payer': 'Requester'|'BucketOwner'
}
)
TABLE OF CONTENTS
(../../guide/quickstart.html) RequestPaymentConfiguration (dict) --
(../../guide/sqs.html) Payer (string) -- [REQUIRED]
Code Examples Specifies who pays for the download and request fees.
User Guides None
Available Services (index.html) reload ()

ACM (acm.html) Calls S3.Client.get_bucket_request_payment() to update the attributes of the
BucketRequestPayment resource. Note that the load and reload methods are
the same method and can be used interchangeably.
AlexaForBusiness
Request Syntax
APIGateway
(apigateway.html)
bucket_request_payment.reload()
Api
api.html) None
Boto 3 Docs 1.9.249
Sub-resources
documentation (
../../index.html)
TABLE OF CONTENTS (../../guide/resources.html#subresources-intro).
Quickstart Bucket ()
(../../guide/quickstart.html) Creates a Bucket resource.:
A Sample Tutorial
(../../guide/sqs.html) bucket = bucket_request_payment.Bucket()
Code Examples
S3.Bucket
User Guides

A Bucket resource
ACM (acm.html)
AlexaForBusiness
BucketTagging
class S3. BucketTagging (bucket_name)
A resource representing an Amazon Simple Storage Service (S3) BucketTagging:
APIGateway
(apigateway.html)
import boto3
Api
bucket_tagging = s3.BucketTagging('bucket_name')
api.html)
Parameters
Boto 3 Docs 1.9.249
bucket_name (string) -- The BucketTagging's bucket_name identifier. This must
documentation ( be set.
../../index.html)
TABLE OF CONTENTS bucket_name
Quickstart These are the resource's available attributes:

(../../guide/quickstart.html) tag_set
A Sample Tutorial These are the resource's available actions:
delete()
Code Examples get_available_subresources()
(../../guide/examples.html) load()
User Guides put()

(../../guide/index.html) reload()

Bucket()
ACM (acm.html)
Identifiers
AlexaForBusiness resource. For more information about identifiers refer to the Resources
(alexaforbusiness.html) Introduction Guide (../../guide/resources.html#identifiers-attributes-intro).
Amplify (amplify.html) bucket_name
APIGateway (string) The BucketTagging's bucket_name identifier. This must be set.
(apigateway.html)
Attributes
Api
api.html)
Boto 3 Docs 1.9.249
documentation ( tag_set
../../index.html) (list) --
(dict) --
TABLE OF CONTENTS
Key (string) --
Quickstart Name of the tag.

(../../guide/quickstart.html) Value (string) --
A Sample Tutorial Value of the tag.
Actions
Code Examples
(../../guide/examples.html) Actions call operations on resources. They may automatically handle the passing in
User Guides actions refer to the Resources Introduction Guide
(../../guide/index.html) (../../guide/resources.html#actions-intro).
Available Services (index.html) delete ()
ACM (acm.html) Deletes the tags from the bucket.
ACMPCA (acm-pca.html) See also: AWS API Documentation

AlexaForBusiness 01/DeleteBucketTagging)
Request Syntax
APIGateway
response = bucket_tagging.delete()
(apigateway.html)
Returns
Api
(apigatewaymanagement None
api.html)
Boto 3 Docs 1.9.249 get_available_subresources ()
documentation (
list of str
Quickstart
A Sample Tutorial load ()

(../../guide/sqs.html) Calls S3.Client.get_bucket_tagging() to update the attributes of the
BucketTagging resource. Note that the load and reload methods are the same
Code Examples
User Guides
Request Syntax
ACM (acm.html) bucket_tagging.load()

APIGateway put (**kwargs)

(apigateway.html)
Sets the tags for a bucket.
Api
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketTagging)
Boto 3 Docs 1.9.249 response = bucket_tagging.put(
documentation ( Tagging={
../../index.html) 'TagSet': [
{
'Key': 'string',
TABLE OF CONTENTS
'Value': 'string'
},
Quickstart
]
}
A Sample Tutorial )
Code Examples
Parameters
Tagging (dict) --
ACM (acm.html) Name of the tag.
ACMPCA (acm-pca.html) Value (string) -- [REQUIRED]
AlexaForBusiness Value of the tag.
APIGateway
(apigateway.html)
reload ()
ApiGatewayManagement Calls S3.Client.get_bucket_tagging() to update the attributes of the
Api BucketTagging resource. Note that the load and reload methods are the same
(apigatewaymanagement method and can be used interchangeably.
api.html)
Boto 3 Docs 1.9.249
documentation (
Request Syntax
../../index.html)
TABLE OF CONTENTS bucket_tagging.reload()
Quickstart Returns
None
A Sample Tutorial
Sub-resources
Code Examples
User Guides sub-resources refer to the Resources Introduction Guide
(../../guide/index.html) (../../guide/resources.html#subresources-intro).
Available Services (index.html) Bucket ()

ACM (acm.html)
bucket = bucket_tagging.Bucket()
AlexaForBusiness
Return type
S3.Bucket
APIGateway
Returns
(apigateway.html)
A Bucket resource
Api
api.html)
Boto 3 Docs 1.9.249
documentation (
BucketVersioning
../../index.html)
class S3. BucketVersioning (bucket_name)
A resource representing an Amazon Simple Storage Service (S3) BucketVersioning:
TABLE OF CONTENTS
Quickstart import boto3

A Sample Tutorial
bucket_versioning = s3.BucketVersioning('bucket_name')
Code Examples
bucket_name (string) -- The BucketVersioning's bucket_name identifier. This
User Guides must be set.
bucket_name
ACM (acm.html)
mfa_delete
AlexaForBusiness
status
enable()
APIGateway
(apigateway.html)
load()
ApiGatewayManagement put()
Api reload()
suspend()
api.html)
Boto 3 Docs 1.9.249
(string) The BucketVersioning's bucket_name identifier. This must be set.
A Sample Tutorial
Code Examples
(../../guide/index.html) mfa_delete
Available Services (index.html) (string) --
ACM (acm.html) Specifies whether MFA delete is enabled in the bucket versioning
configured with MFA delete. If the bucket has never been so configured,
AlexaForBusiness this element is not returned.
status
(string) --
APIGateway
The versioning state of the bucket.
(apigateway.html)
ApiGatewayManagement Actions
Api Actions call operations on resources. They may automatically handle the passing in
(apigatewaymanagement of arguments set from identifiers and some attributes. For more information about
api.html) actions refer to the Resources Introduction Guide
Boto 3 Docs 1.9.249
documentation ( enable (**kwargs)
../../index.html) Sets the versioning state of an existing bucket. To set the versioning state, you
must be the bucket owner.
Quickstart 01/PutBucketVersioning)
Request Syntax
A Sample Tutorial
response = bucket_versioning.enable(
Code Examples MFA='string',
)
User Guides
Parameters
ACM (acm.html) number, a space, and the value that is displayed on your authentication
ACMPCA (acm-pca.html) device.
APIGateway get_available_subresources ()
(apigateway.html) Returns a list of all the available sub-resources for this Resource.
Api A list containing the name of each sub-resource for this resource
list of str
Boto 3 Docs 1.9.249
documentation (
Calls S3.Client.get_bucket_versioning() to update the attributes of the
TABLE OF CONTENTS BucketVersioning resource. Note that the load and reload methods are the
same method and can be used interchangeably.
Quickstart
A Sample Tutorial
Request Syntax
Code Examples
bucket_versioning.load()
User Guides
Returns
None
ACM (acm.html)
put (**kwargs)
ACMPCA (acm-pca.html) Sets the versioning state of an existing bucket. To set the versioning state, you
AlexaForBusiness must be the bucket owner.
01/PutBucketVersioning)
APIGateway
Api
api.html)
Boto 3 Docs 1.9.249 response = bucket_versioning.put(
documentation ( MFA='string',
../../index.html) VersioningConfiguration={
'MFADelete': 'Enabled'|'Disabled',
TABLE OF CONTENTS
}
)
Quickstart

(../../guide/sqs.html) MFA (string) -- The concatenation of the authentication device's serial
Code Examples
device.
VersioningConfiguration (dict) --
(../../guide/index.html) MFADelete (string) --
Specifies whether MFA delete is enabled in the bucket versioning
ACM (acm.html) configured with MFA delete. If the bucket has never been so
ACMPCA (acm-pca.html) configured, this element is not returned.
AlexaForBusiness Status (string) --

(alexaforbusiness.html) The versioning state of the bucket.
Amplify (amplify.html) Returns

None
APIGateway
(apigateway.html)
ApiGatewayManagement reload ()
Api Calls S3.Client.get_bucket_versioning() to update the attributes of the
(apigatewaymanagement BucketVersioning resource. Note that the load and reload methods are the
api.html) same method and can be used interchangeably.
Boto 3 Docs 1.9.249
documentation (
Request Syntax
../../index.html)
TABLE OF CONTENTS bucket_versioning.reload()
Quickstart Returns
None
A Sample Tutorial
suspend (**kwargs)
Code Examples
(../../guide/examples.html) Sets the versioning state of an existing bucket. To set the versioning state, you
must be the bucket owner.
User Guides
Available Services (index.html) 01/PutBucketVersioning)
response = bucket_versioning.suspend(
AlexaForBusiness
MFA='string',
Amplify (amplify.html) )
APIGateway
(apigateway.html)
Parameters
ApiGatewayManagement MFA (string) -- The concatenation of the authentication device's serial
Api number, a space, and the value that is displayed on your authentication
(apigatewaymanagement device.
api.html)
Returns
Boto 3 Docs 1.9.249
None
documentation (
../../index.html)
Sub-resources
TABLE OF CONTENTS Sub-resources are methods that create a new instance of a child resource. This
Quickstart sub-resources refer to the Resources Introduction Guide
(../../guide/quickstart.html) (../../guide/resources.html#subresources-intro).
A Sample Tutorial Bucket ()

(../../guide/sqs.html) Creates a Bucket resource.:
Code Examples
(../../guide/examples.html) bucket = bucket_versioning.Bucket()
User Guides
Available Services (index.html) S3.Bucket

A Bucket resource
AlexaForBusiness
BucketWebsite
APIGateway
(apigateway.html) class S3. BucketWebsite (bucket_name)
A resource representing an Amazon Simple Storage Service (S3) BucketWebsite:
Api
api.html)
documentation (
bucket_website = s3.BucketWebsite('bucket_name')
TABLE OF CONTENTS
Parameters
Quickstart bucket_name (string) -- The BucketWebsite's bucket_name identifier. This must
(../../guide/quickstart.html) be set.
A Sample Tutorial
bucket_name
Code Examples
(../../guide/examples.html) These are the resource's available attributes:
User Guides error_document

(../../guide/index.html) index_document
redirect_all_requests_to
routing_rules
ACM (acm.html)
delete()
(alexaforbusiness.html) load()
Amplify (amplify.html) put()
reload()
APIGateway
(apigateway.html) These are the resource's available sub-resources:
ApiGatewayManagement Bucket()
Api Identifiers
api.html)
Boto 3 Docs 1.9.249
../../index.html)
bucket_name
(string) The BucketWebsite's bucket_name identifier. This must be set.
TABLE OF CONTENTS
Attributes
Code Examples error_document

User Guides Key (string) --

The object key name to use when a 4XX class error occurs.
index_document
ACM (acm.html)
(dict) --
Suffix (string) --
AlexaForBusiness
A suffix that is appended to a request that is for a directory on the
website endpoint (e.g. if the suffix is index.html and you make a
Amplify (amplify.html) request to samplebucket/images/ the data that is returned will be for
the object with the key name images/index.html) The suffix must not
APIGateway
(apigateway.html)
ApiGatewayManagement redirect_all_requests_to
Api (dict) --
api.html)
Name of the host where requests are redirected.
Boto 3 Docs 1.9.249
documentation ( Protocol (string) --
../../index.html) Protocol to use when redirecting requests. The default is the

TABLE OF CONTENTS
routing_rules
Quickstart (list) --
A Sample Tutorial Specifies the redirect behavior and when a redirect is applied.
Condition (dict) --
Code Examples
A container for describing a condition that must be met for the
specified redirect to apply. For example, 1. If request is for
User Guides pages in the /docs folder, redirect to the /documents folder. 2.
(../../guide/index.html) If request results in HTTP error 4xx, redirect request to another
host where you might process the error.
ACM (acm.html)
The HTTP error code when the redirect is applied. In the
event of an error, if the error code equals this value, then
AlexaForBusiness the specified redirect is applied. Required when parent
(alexaforbusiness.html) element Condition is specified and sibling
KeyPrefixEquals is not specified. If both are specified,
then both must be true for the redirect to be applied.
APIGateway
(apigateway.html)
The object key name prefix when the redirect is applied.
For example, to redirect requests for ExamplePage.html ,
Api
the key prefix will be ExamplePage.html . To redirect
api.html)
request for all pages with the prefix docs/ , the key prefix
will be /docs , which identifies all objects in the docs/
Boto 3 Docs 1.9.249
folder. Required when the parent element Condition is
documentation ( specified and sibling HttpErrorCodeReturnedEquals is not
../../index.html) specified. If both conditions are specified, both must be
true for the redirect to be applied.
TABLE OF CONTENTS
Redirect (dict) --
Quickstart Container for redirect information. You can redirect requests to

(../../guide/quickstart.html) another host, to another page, or with another protocol. In the
event of an error, you can specify a different error code to
A Sample Tutorial return.
Code Examples
(../../guide/examples.html) The host name to use in the redirect request.
HttpRedirectCode (string) --
User Guides
(../../guide/index.html) The HTTP redirect code to use on the response. Not
required if one of the siblings is present.
ACM (acm.html)
Protocol to use when redirecting requests. The default is
the protocol that is used in the original request.
AlexaForBusiness
ReplaceKeyPrefixWith (string) --
The object key prefix to use in the redirect request. For
example, to redirect requests for all pages with prefix
APIGateway docs/ (objects in the docs/ folder) to documents/ , you
(apigateway.html) can set a condition block with KeyPrefixEquals set to
docs/ and in the Redirect set ReplaceKeyPrefixWith to
/documents . Not required if one of the siblings is present.
Api
Can be present only if ReplaceKeyWith is not provided.
api.html) ReplaceKeyWith (string) --
Boto 3 Docs 1.9.249
example, redirect request to error.html . Not required if
documentation ( one of the siblings is present. Can be present only if
../../index.html) ReplaceKeyPrefixWith is not provided.
TABLE OF CONTENTS Actions

Quickstart of arguments set from identifiers and some attributes. For more information about
(../../guide/quickstart.html) actions refer to the Resources Introduction Guide
A Sample Tutorial
(../../guide/sqs.html) delete ()
Code Examples This operation removes the website configuration from the bucket.
User Guides
01/DeleteBucketWebsite)
Request Syntax
ACM (acm.html)
response = bucket_website.delete()
APIGateway
(apigateway.html)
Returns
Api
(apigatewaymanagement A list containing the name of each sub-resource for this resource
list of str
Boto 3 Docs 1.9.249
documentation (
Calls S3.Client.get_bucket_website() to update the attributes of the
TABLE OF CONTENTS BucketWebsite resource. Note that the load and reload methods are the same
Quickstart
A Sample Tutorial
Request Syntax
Code Examples
bucket_website.load()
User Guides
Returns
None
ACM (acm.html)
put (**kwargs)
ACMPCA (acm-pca.html) Set the website configuration for a bucket.
(alexaforbusiness.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketWebsite)
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = bucket_website.put(
documentation ( WebsiteConfiguration={
../../index.html) 'ErrorDocument': {
'Key': 'string'
},
TABLE OF CONTENTS
'IndexDocument': {
'Suffix': 'string'
Quickstart
},
'RedirectAllRequestsTo': {
A Sample Tutorial 'HostName': 'string',
(../../guide/sqs.html) 'Protocol': 'http'|'https'
Code Examples },
(../../guide/examples.html) 'RoutingRules': [
{
User Guides
'Condition': {
'HttpErrorCodeReturnedEquals': 'string',
Available Services (index.html) 'KeyPrefixEquals': 'string'
},
ACM (acm.html)
'Redirect': {
ACMPCA (acm-pca.html) 'HostName': 'string',
'HttpRedirectCode': 'string',
AlexaForBusiness
(alexaforbusiness.html) 'Protocol': 'http'|'https',
'ReplaceKeyPrefixWith': 'string',
Amplify (amplify.html) 'ReplaceKeyWith': 'string'
APIGateway }
]
}
Api
)
api.html)
Parameters
Boto 3 Docs 1.9.249
WebsiteConfiguration (dict) --
documentation (
[REQUIRED]
../../index.html)
The name of the error document for the website.
TABLE OF CONTENTS
Quickstart The object key name to use when a 4XX class error occurs.
(../../guide/quickstart.html) IndexDocument (dict) --
A Sample Tutorial The name of the index document for the website.
(../../guide/sqs.html) Suffix (string) -- [REQUIRED]
Code Examples A suffix that is appended to a request that is for a directory on the
(../../guide/examples.html) website endpoint (e.g. if the suffix is index.html and you make a
request to samplebucket/images/ the data that is returned will be for
User Guides the object with the key name images/index.html) The suffix must not
(../../guide/index.html) be empty and must not include a slash character.
Available Services (index.html) RedirectAllRequestsTo (dict) --

The redirect behavior for every request to this bucket's website endpoint.
ACM (acm.html)
Warning
AlexaForBusiness
If you specify this property, you can't specify any other property.
HostName (string) -- [REQUIRED]
APIGateway
Name of the host where requests are redirected.
(apigateway.html)
Protocol to use when redirecting requests. The default is the protocol
Api
api.html) RoutingRules (list) --
Rules that define when a redirect is applied and the redirect behavior.
Boto 3 Docs 1.9.249
../../index.html)
Condition (dict) --
TABLE OF CONTENTS A container for describing a condition that must be met for the
specified redirect to apply. For example, 1. If request is for pages in
Quickstart
results in HTTP error 4xx, redirect request to another host where you
might process the error.
A Sample Tutorial
The HTTP error code when the redirect is applied. In the event of
Code Examples an error, if the error code equals this value, then the specified
(../../guide/examples.html) redirect is applied. Required when parent element Condition is
specified and sibling KeyPrefixEquals is not specified. If both are
User Guides
specified, then both must be true for the redirect to be applied.
ACM (acm.html) example, to redirect requests for ExamplePage.html , the key prefix
will be ExamplePage.html . To redirect request for all pages with
the prefix docs/ , the key prefix will be /docs , which identifies all
AlexaForBusiness objects in the docs/ folder. Required when the parent element
(alexaforbusiness.html) Condition is specified and sibling HttpErrorCodeReturnedEquals is
Amplify (amplify.html) not specified. If both conditions are specified, both must be true
for the redirect to be applied.
APIGateway
(apigateway.html) Redirect (dict) -- [REQUIRED]
another host, to another page, or with another protocol. In the event
Api
of an error, you can specify a different error code to return.
api.html) HostName (string) --
The host name to use in the redirect request.
Boto 3 Docs 1.9.249
documentation ( HttpRedirectCode (string) --
The HTTP redirect code to use on the response. Not required if one
../../index.html)
of the siblings is present.
TABLE OF CONTENTS Protocol (string) --

Protocol to use when redirecting requests. The default is the
Quickstart
(../../guide/quickstart.html) ReplaceKeyPrefixWith (string) --
The object key prefix to use in the redirect request. For example, to
A Sample Tutorial
redirect requests for all pages with prefix docs/ (objects in the
docs/ folder) to documents/ , you can set a condition block with
Code Examples KeyPrefixEquals set to docs/ and in the Redirect set
(../../guide/examples.html) ReplaceKeyPrefixWith to /documents . Not required if one of the
User Guides siblings is present. Can be present only if ReplaceKeyWith is not

(../../guide/index.html) provided.
The specific object key to use in the redirect request. For example,
ACM (acm.html) redirect request to error.html . Not required if one of the siblings
ACMPCA (acm-pca.html) is present. Can be present only if ReplaceKeyPrefixWith is not
provided.
AlexaForBusiness
None
APIGateway
(apigateway.html) reload ()
ApiGatewayManagement Calls S3.Client.get_bucket_website() to update the attributes of the

Api BucketWebsite resource. Note that the load and reload methods are the same
(apigatewaymanagement method and can be used interchangeably.
api.html)
Boto 3 Docs 1.9.249
documentation (
Request Syntax
../../index.html)
TABLE OF CONTENTS bucket_website.reload()
Quickstart Returns
None
A Sample Tutorial
Sub-resources
Code Examples
User Guides sub-resources refer to the Resources Introduction Guide
(../../guide/index.html) (../../guide/resources.html#subresources-intro).
Available Services (index.html) Bucket ()

ACM (acm.html)
bucket = bucket_website.Bucket()
AlexaForBusiness
Return type
S3.Bucket
APIGateway
Returns
(apigateway.html)
A Bucket resource
Api
api.html)
Boto 3 Docs 1.9.249
documentation (
MultipartUpload
../../index.html)
class S3. MultipartUpload (bucket_name, object_key, id)
A resource representing an Amazon Simple Storage Service (S3) MultipartUpload:
TABLE OF CONTENTS

A Sample Tutorial
multipart_upload = s3.MultipartUpload('bucket_name','object_key','id')
Code Examples
bucket_name (string) -- The MultipartUpload's bucket_name identifier. This
(../../guide/index.html) object_key (string) -- The MultipartUpload's object_key identifier. This must
be set.
id (string) -- The MultipartUpload's id identifier. This must be set.
ACM (acm.html)
bucket_name
AlexaForBusiness
object_key
id
APIGateway
(apigateway.html) initiated
initiator
ApiGatewayManagement key
Api
owner
storage_class
api.html)
upload_id
Boto 3 Docs 1.9.249
documentation ( These are the resource's available actions:
../../index.html) abort()
complete()

Quickstart
(../../guide/quickstart.html) Object()
Part()
A Sample Tutorial
(../../guide/sqs.html) These are the resource's available collections:
Code Examples parts

(../../guide/examples.html) Identifiers
User Guides Identifiers are properties of a resource that are set upon instantation of the
(../../guide/index.html) resource. For more information about identifiers refer to the Resources
bucket_name
ACM (acm.html) (string) The MultipartUpload's bucket_name identifier. This must be set.
object_key
AlexaForBusiness
(string) The MultipartUpload's object_key identifier. This must be set.
Amplify (amplify.html) id
(string) The MultipartUpload's id identifier. This must be set.
APIGateway
(apigateway.html)
Attributes
ApiGatewayManagement Attributes provide access to the properties of a resource. Attributes are lazy-loaded
Api the first time one is accessed via the load() method. For more information about
(apigatewaymanagement attributes refer to the Resources Introduction Guide
api.html) (../../guide/resources.html#identifiers-attributes-intro).
initiated
Boto 3 Docs 1.9.249
(datetime) --
documentation (
../../index.html) Date and time at which the multipart upload was initiated.
initiator
TABLE OF CONTENTS
(dict) --
Quickstart Identifies who initiated the multipart upload.

(../../guide/quickstart.html) ID (string) --
A Sample Tutorial If the principal is an AWS account, it provides the Canonical User ID.
(../../guide/sqs.html) If the principal is an IAM User, it provides a user ARN value.
Code Examples DisplayName (string) --
User Guides
(../../guide/index.html) key
(string) --
Key of the object for which the multipart upload was initiated.
ACM (acm.html)
ACMPCA (acm-pca.html) owner
AlexaForBusiness (dict) --
ID (string) --
APIGateway storage_class

Api
(apigatewaymanagement upload_id
Boto 3 Docs 1.9.249
documentation ( Actions
../../index.html) Actions call operations on resources. They may automatically handle the passing in
TABLE OF CONTENTS actions refer to the Resources Introduction Guide
Quickstart abort (**kwargs)
Aborts a multipart upload.
A Sample Tutorial
To verify that all parts have been removed, so you don't get charged for the
part storage, you should call the List Parts operation and ensure the parts list is
Code Examples empty.
(../../guide/index.html) 01/AbortMultipartUpload)
ACM (acm.html)
response = multipart_upload.abort(
ACMPCA (acm-pca.html) RequestPayer='requester'
AlexaForBusiness )

APIGateway RequestPayer (string) -- Confirms that the requester knows that she or he
(apigateway.html) will be charged for the request. Bucket owners need not specify this
parameter in their requests. Documentation on downloading objects from
ApiGatewayManagement requester pays buckets can be found at
Api http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBucke
(apigatewaymanagement (http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBucke
api.html)
Return type
Boto 3 Docs 1.9.249
dict
documentation (
Response Syntax
TABLE OF CONTENTS
{
Quickstart 'RequestCharged': 'requester'
A Sample Tutorial
(../../guide/examples.html) RequestCharged (string) --
User Guides
request.

complete (**kwargs)
ACM (acm.html)
Completes a multipart upload by assembling previously uploaded parts.
(alexaforbusiness.html) 01/CompleteMultipartUpload)
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 object = multipart_upload.complete(
documentation ( MultipartUpload={
../../index.html) 'Parts': [
{
'ETag': 'string',
TABLE OF CONTENTS
'PartNumber': 123
},
Quickstart
]
},
A Sample Tutorial RequestPayer='requester'
Code Examples
Parameters
User Guides MultipartUpload (dict) --
(../../guide/index.html) Parts (list) --
(dict) --
Available Services (index.html) ETag (string) --
ACM (acm.html) Entity tag returned when the part was uploaded.
ACMPCA (acm-pca.html) PartNumber (integer) --

Part number that identifies the part. This is a positive integer
AlexaForBusiness
between 1 and 10,000.
APIGateway parameter in their requests. Documentation on downloading objects
(apigateway.html) from requester pays buckets can be found at
Api
api.html) s3.Object
Returns
Boto 3 Docs 1.9.249
Object resource
documentation (
../../index.html)
TABLE OF CONTENTS Returns a list of all the available sub-resources for this Resource.
Returns
Quickstart
Return type
A Sample Tutorial
Code Examples
(../../guide/examples.html) Sub-resources
User Guides
Available Services (index.html) (../../guide/resources.html#subresources-intro).
ACM (acm.html) Object ()

ACMPCA (acm-pca.html) Creates a Object resource.:
AlexaForBusiness
(alexaforbusiness.html) object = multipart_upload.Object()

(apigateway.html) S3.Object
Api A Object resource
api.html)
Boto 3 Docs 1.9.249 Part (part_number)
Creates a MultipartUploadPart resource.:
documentation (
../../index.html)
multipart_upload_part = multipart_upload.Part('part_number')
TABLE OF CONTENTS
Parameters
Quickstart part_number (string) -- The Part's part_number identifier. This must be set.
Return type
A Sample Tutorial
S3.MultipartUploadPart
Returns
Code Examples
A MultipartUploadPart resource
User Guides
(../../guide/index.html) Collections
Available Services (index.html) For more information about collections refer to the Resources Introduction Guide
ACM (acm.html) (../../guide/collections.html#guide-collections).
ACMPCA (acm-pca.html) parts

A collection of MultipartUploadPart resources
AlexaForBusiness
(alexaforbusiness.html) all ()
Amplify (amplify.html) Creates an iterable of all MultipartUploadPart resources in the collection.

(apigateway.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListParts)

Api
multipart_upload_part_iterator = multipart_upload.parts.all()
api.html)
Return type
Boto 3 Docs 1.9.249
list( s3.MultipartUploadPart )
documentation (
A list of MultipartUploadPart resources
TABLE OF CONTENTS
filter (**kwargs)
Quickstart
(../../guide/quickstart.html) Creates an iterable of all MultipartUploadPart resources in the collection
filtered by kwargs passed to method.
A Sample Tutorial
Code Examples
User Guides
multipart_upload_part_iterator = multipart_upload.parts.filter(
MaxParts=123,
Available Services (index.html) PartNumberMarker=123,
ACM (acm.html)
)
AlexaForBusiness
Parameters
MaxParts (integer) -- Sets the maximum number of parts to return.
Amplify (amplify.html) PartNumberMarker (integer) -- Specifies the part after which listing
should begin. Only parts with higher part numbers will be listed.
APIGateway
(apigateway.html)
ApiGatewayManagement this parameter in their requests. Documentation on downloading
Api objects from requester pays buckets can be found at
(apigatewaymanagement http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPays
api.html) (http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPays
Return type
Boto 3 Docs 1.9.249
documentation (
A list of MultipartUploadPart resources
TABLE OF CONTENTS
limit (**kwargs)
Quickstart
(../../guide/quickstart.html) Creates an iterable up to a specified amount of MultipartUploadPart
resources in the collection.
A Sample Tutorial
Code Examples
User Guides
multipart_upload_part_iterator = multipart_upload.parts.limit(
count=123
ACM (acm.html)

AlexaForBusiness
Returns
APIGateway
(apigateway.html) A list of MultipartUploadPart resources
Api page_size (**kwargs)
api.html)
Creates an iterable of all MultipartUploadPart resources in the collection,
Boto 3 Docs 1.9.249
but limits the number of items returned by each service call by the specified
documentation ( amount.
../../index.html)
TABLE OF CONTENTS
Request Syntax
Quickstart
(../../guide/quickstart.html) multipart_upload_part_iterator = multipart_upload.parts.page_size(
A Sample Tutorial count=123

Code Examples
Parameters
User Guides count (integer) -- The number of items returned by each service call
Return type
Available Services (index.html) list( s3.MultipartUploadPart )
ACMPCA (acm-pca.html) A list of MultipartUploadPart resources
AlexaForBusiness
Amplify (amplify.html) MultipartUploadPart

APIGateway
(apigateway.html) class S3. MultipartUploadPart (bucket_name, object_key, multipart_upload_id,
ApiGatewayManagement part_number)
Api A resource representing an Amazon Simple Storage Service (S3)
(apigatewaymanagement MultipartUploadPart:
api.html)
documentation (
multipart_upload_part = s3.MultipartUploadPart('bucket_name','object_key'
TABLE OF CONTENTS
(../../guide/quickstart.html) bucket_name (string) -- The MultipartUploadPart's bucket_name identifier.
This must be set.
A Sample Tutorial
object_key (string) -- The MultipartUploadPart's object_key identifier. This
must be set.
Code Examples multipart_upload_id (string) -- The MultipartUploadPart's
(../../guide/examples.html) multipart_upload_id identifier. This must be set.
part_number (string) -- The MultipartUploadPart's part_number identifier.
User Guides
This must be set.
Available Services (index.html) These are the resource's available identifiers:
ACM (acm.html) bucket_name

object_key
ACMPCA (acm-pca.html) multipart_upload_id
AlexaForBusiness part_number
e_tag
APIGateway last_modified
(apigateway.html) size
ApiGatewayManagement These are the resource's available actions:

Api
copy_from()
api.html)
upload()
Boto 3 Docs 1.9.249
documentation ( These are the resource's available sub-resources:
../../index.html) MultipartUpload()
Identifiers
TABLE OF CONTENTS
Quickstart Introduction Guide (../../guide/resources.html#identifiers-attributes-intro).
bucket_name
A Sample Tutorial
(string) The MultipartUploadPart's bucket_name identifier. This must be set.
Code Examples object_key

(../../guide/examples.html) (string) The MultipartUploadPart's object_key identifier. This must be set.
User Guides multipart_upload_id

(string) The MultipartUploadPart's multipart_upload_id identifier. This must be
Available Services (index.html) set.
ACM (acm.html) part_number

ACMPCA (acm-pca.html) (string) The MultipartUploadPart's part_number identifier. This must be set.
AlexaForBusiness
Attributes
Amplify (amplify.html) the first time one is accessed via the load() method. For more information about
APIGateway attributes refer to the Resources Introduction Guide
(apigateway.html) (../../guide/resources.html#identifiers-attributes-intro).
ApiGatewayManagement e_tag
Api (string) --
Entity tag returned when the part was uploaded.
api.html)
last_modified
Boto 3 Docs 1.9.249
(datetime) --
documentation (
../../index.html) Date and time at which the part was uploaded.
size
TABLE OF CONTENTS
(integer) --
Quickstart Size in bytes of the uploaded part data.

Actions
A Sample Tutorial
Code Examples actions refer to the Resources Introduction Guide
(../../guide/examples.html) (../../guide/resources.html#actions-intro).
User Guides copy_from (**kwargs)

(../../guide/index.html) Uploads a part by copying data from an existing object as data source.

(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPartCopy)
ACM (acm.html)
Request Syntax
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = multipart_upload_part.copy_from(
documentation ( CopySource='string' or {'Bucket': 'string', 'Key': 'string', 'Vers
../../index.html) CopySourceIfMatch='string',
CopySourceIfModifiedSince=datetime(2015, 1, 1),
CopySourceIfNoneMatch='string',
TABLE OF CONTENTS
CopySourceIfUnmodifiedSince=datetime(2015, 1, 1),
CopySourceRange='string',
Quickstart
A Sample Tutorial CopySourceSSECustomerAlgorithm='string',
(../../guide/sqs.html) CopySourceSSECustomerKey='string',
Code Examples RequestPayer='requester'
(../../guide/examples.html) )
User Guides
Parameters
Available Services (index.html) CopySource (str or dict) -- [REQUIRED] The name of the source bucket,
ACM (acm.html) key name of the source object, and optional version ID of the source
ACMPCA (acm-pca.html) string form is {bucket}/{key} or {bucket}/{key}?versionId={versionId} if
AlexaForBusiness you want to copy a specific version. You can also provide this value as a
(alexaforbusiness.html) dictionary. The dictionary format is recommended over the string format
APIGateway may be omitted.
(apigateway.html) CopySourceIfMatch (string) -- Copies the object if its entity tag (ETag)
CopySourceIfModifiedSince (datetime) -- Copies the object if it has been
Api
modified since the specified time.
api.html)
Boto 3 Docs 1.9.249
(ETag) is different than the specified ETag.
documentation ( CopySourceIfUnmodifiedSince (datetime) -- Copies the object if it hasn't
../../index.html) been modified since the specified time.
CopySourceRange (string) -- The range of bytes to copy from the source
TABLE OF CONTENTS object. The range value must use the form bytes=first-last, where the first
and last are the zero-based byte offsets to copy. For example, bytes=0-9
Quickstart indicates that you want to copy the first ten bytes of the source. You can
(../../guide/quickstart.html) copy a range only if the source object is greater than 5 MB.
A Sample Tutorial encrypting the object (e.g., AES256).
(../../guide/sqs.html) SSECustomerKey (string) -- Specifies the customer-provided encryption
Code Examples key for Amazon S3 to use in encrypting data. This value is used to store
(../../guide/examples.html) the object and then it is discarded; Amazon does not store the encryption
User Guides the x-amz-server-side-encryption-customer-algorithm header. This must
(../../guide/index.html) be the same encryption key specified in the initiate multipart upload
request.
ACM (acm.html) Specifies the 128-bit MD5 digest of the encryption key according to RFC
AlexaForBusiness
APIGateway
(apigateway.html)
ApiGatewayManagement use when decrypting the source object (e.g., AES256).
Api CopySourceSSECustomerKey (string) -- Specifies the customer-provided
(apigatewaymanagement encryption key for Amazon S3 to use to decrypt the source object. The
api.html)
encryption key provided in this header must be one that was used when
Boto 3 Docs 1.9.249
documentation ( CopySourceSSECustomerKeyMD5 (string) --
../../index.html) Specifies the 128-bit MD5 digest of the encryption key according to RFC
TABLE OF CONTENTS ensure the encryption key was transmitted without error.
Quickstart
A Sample Tutorial
Code Examples he will be charged for the request. Bucket owners need not specify this
(../../guide/examples.html) parameter in their requests. Documentation on downloading objects
User Guides
ACM (acm.html) dict

APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'CopySourceVersionId': 'string',
../../index.html) 'CopyPartResult': {
'ETag': 'string',
TABLE OF CONTENTS
},
Quickstart
A Sample Tutorial 'SSEKMSKeyId': 'string',
(../../guide/sqs.html) 'RequestCharged': 'requester'
Code Examples }

Available Services (index.html) CopySourceVersionId (string) --
ACM (acm.html) The version of the source object that was copied, if you have enabled
ACMPCA (acm-pca.html) versioning on the source bucket.
AlexaForBusiness CopyPartResult (dict) --

(alexaforbusiness.html) ETag (string) --
Amplify (amplify.html) Entity tag of the object.
APIGateway LastModified (datetime) --
(apigateway.html)
Date and time at which the object was uploaded.
Api
(apigatewaymanagement The Server-side encryption algorithm used when storing this object in
api.html) S3 (e.g., AES256, aws:kms).
Boto 3 Docs 1.9.249
documentation ( If server-side encryption with a customer-provided encryption key was
../../index.html)
TABLE OF CONTENTS SSECustomerKeyMD5 (string) --

Quickstart requested, the response will include this header to provide round trip
(../../guide/quickstart.html) message integrity verification of the customer-provided encryption key.
A Sample Tutorial SSEKMSKeyId (string) --
Code Examples master encryption key that was used for the object.
User Guides If present, indicates that the requester was successfully charged for the
(../../guide/index.html) request.
ACM (acm.html) get_available_subresources ()

ACMPCA (acm-pca.html) Returns a list of all the available sub-resources for this Resource.
(alexaforbusiness.html) A list containing the name of each sub-resource for this resource
APIGateway list of str
(apigateway.html)
upload (**kwargs)
Api
Uploads a part in a multipart upload.
api.html)
Boto 3 Docs 1.9.249 Note: After you initiate multipart upload and upload one or more parts,
documentation ( you must either complete or abort multipart upload in order to stop
../../index.html) 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.
TABLE OF CONTENTS
Quickstart See also: AWS API Documentation

(../../guide/quickstart.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPart)
A Sample Tutorial Request Syntax
Code Examples response = multipart_upload_part.upload(

(../../guide/examples.html) Body=b'bytes'|file,
ContentLength=123,
User Guides
ACM (acm.html) RequestPayer='requester'

)
AlexaForBusiness
Parameters
Amplify (amplify.html) ContentLength (integer) -- Size of the body in bytes. This parameter is
APIGateway useful when the size of the body cannot be determined automatically.
(apigateway.html) ContentMD5 (string) -- The base64-encoded 128-bit MD5 digest of the
ApiGatewayManagement from the CLI. This parameted is required if object lock parameters are
Api specified.
(apigatewaymanagement SSECustomerAlgorithm (string) -- Specifies the algorithm to use to when
api.html) encrypting the object (e.g., AES256).
Boto 3 Docs 1.9.249
documentation ( the object and then it is discarded; Amazon does not store the encryption
../../index.html) key. The key must be appropriate for use with the algorithm specified in
TABLE OF CONTENTS be the same encryption key specified in the initiate multipart upload
request.
Quickstart SSECustomerKeyMD5 (string) --
(../../guide/quickstart.html) Specifies the 128-bit MD5 digest of the encryption key according to RFC
A Sample Tutorial ensure the encryption key was transmitted without error.
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
dict
Returns
APIGateway
(apigateway.html) Response Syntax
Api
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'ServerSideEncryption': 'AES256'|'aws:kms',
../../index.html) 'ETag': 'string',
TABLE OF CONTENTS
Quickstart
}
A Sample Tutorial

(../../guide/examples.html) ServerSideEncryption (string) --
User Guides The Server-side encryption algorithm used when storing this object in
(../../guide/index.html) S3 (e.g., AES256, aws:kms).
Available Services (index.html) ETag (string) --
ACM (acm.html) Entity tag for the uploaded object.
ACMPCA (acm-pca.html) SSECustomerAlgorithm (string) --
AlexaForBusiness If server-side encryption with a customer-provided encryption key was

(alexaforbusiness.html) requested, the response will include this header confirming the
APIGateway
(apigateway.html) If server-side encryption with a customer-provided encryption key was
Api
(apigatewaymanagement SSEKMSKeyId (string) --
api.html)
Boto 3 Docs 1.9.249
documentation (
../../index.html)
TABLE OF CONTENTS request.
Quickstart
Sub-resources
A Sample Tutorial resource's identifiers get passed along to the child. For more information about
(../../guide/sqs.html) sub-resources refer to the Resources Introduction Guide
Code Examples
(../../guide/examples.html) MultipartUpload ()
User Guides Creates a MultipartUpload resource.:
Available Services (index.html) multipart_upload = multipart_upload_part.MultipartUpload()
ACM (acm.html)
Return type
S3.MultipartUpload
AlexaForBusiness
Returns
A MultipartUpload resource
APIGateway
(apigateway.html)
Object
Api
(apigatewaymanagement class S3. Object (bucket_name, key)
api.html) A resource representing an Amazon Simple Storage Service (S3) Object:
documentation (
object = s3.Object('bucket_name','key')
TABLE OF CONTENTS
Parameters
Quickstart bucket_name (string) -- The Object's bucket_name identifier. This must be
(../../guide/quickstart.html) set.
A Sample Tutorial key (string) -- The Object's key identifier. This must be set.
Code Examples
bucket_name
key
User Guides
accept_ranges
cache_control
ACM (acm.html) content_disposition
content_encoding
content_language
AlexaForBusiness content_length
(alexaforbusiness.html) content_type
Amplify (amplify.html) delete_marker
e_tag
APIGateway
expiration
(apigateway.html)
expires
ApiGatewayManagement last_modified
Api metadata
(apigatewaymanagement missing_meta
api.html) object_lock_legal_hold_status
object_lock_mode
Boto 3 Docs 1.9.249
object_lock_retain_until_date
documentation ( parts_count
../../index.html) replication_status
request_charged
TABLE OF CONTENTS restore
server_side_encryption
Quickstart sse_customer_algorithm
(../../guide/quickstart.html) sse_customer_key_md5
ssekms_key_id
A Sample Tutorial
(../../guide/sqs.html) storage_class
version_id
Code Examples website_redirect_location
User Guides
copy()
copy_from()
Available Services (index.html) delete()
ACM (acm.html) download_file()
download_fileobj()
ACMPCA (acm-pca.html) get()
(alexaforbusiness.html) initiate_multipart_upload()
load()
put()
APIGateway reload()
(apigateway.html) restore_object()
ApiGatewayManagement upload_file()
Api upload_fileobj()
api.html)
Acl()
Boto 3 Docs 1.9.249
Bucket()
documentation ( MultipartUpload()
../../index.html) Version()
These are the resource's available waiters:

TABLE OF CONTENTS
wait_until_exists()
Quickstart wait_until_not_exists()
(../../guide/quickstart.html) Identifiers
A Sample Tutorial Identifiers are properties of a resource that are set upon instantation of the
(../../guide/sqs.html) resource. For more information about identifiers refer to the Resources
Code Examples
(../../guide/examples.html) bucket_name
(string) The Object's bucket_name identifier. This must be set.
User Guides
key
Available Services (index.html) (string) The Object's key identifier. This must be set.
ACM (acm.html)
Attributes
ACMPCA (acm-pca.html) Attributes provide access to the properties of a resource. Attributes are lazy-loaded
AlexaForBusiness
accept_ranges
APIGateway
(string) --
(apigateway.html)
ApiGatewayManagement cache_control
Api (string) --
api.html)
content_disposition
Boto 3 Docs 1.9.249
(string) --
documentation (
../../index.html) Specifies presentational information for the object.
content_encoding
TABLE OF CONTENTS
(string) --
Quickstart Specifies what content encodings have been applied to the object and
(../../guide/quickstart.html) thus what decoding mechanisms must be applied to obtain the media-
type referenced by the Content-Type header field.
A Sample Tutorial
(../../guide/sqs.html) content_language
User Guides
(../../guide/index.html) content_length
(integer) --
ACM (acm.html)
ACMPCA (acm-pca.html) content_type

(string) --
AlexaForBusiness
(alexaforbusiness.html) A standard MIME type describing the format of the object data.
delete_marker
APIGateway (boolean) --
(apigateway.html)
ApiGatewayManagement Delete Marker. If false, this response header does not appear in the
Api response.
api.html) e_tag
(string) --
Boto 3 Docs 1.9.249
documentation ( An ETag is an opaque identifier assigned by a web server to a specific
../../index.html)
expiration
TABLE OF CONTENTS
(string) --
Quickstart If the object expiration is configured (see PUT Bucket lifecycle), the
(../../guide/quickstart.html) response includes this header. It includes the expiry-date and rule-id key
value pairs providing object expiration information. The value of the rule-
A Sample Tutorial id is URL encoded.
Code Examples expires

(../../guide/examples.html) (datetime) --
User Guides The date and time at which the object is no longer cacheable.
last_modified
Available Services (index.html) (datetime) --
ACM (acm.html) Last modified date of the object
metadata
(string) --
(apigateway.html)
ApiGatewayManagement missing_meta
Api (integer) --
api.html)
This is set to the number of metadata entries not returned in x-amz-meta
Boto 3 Docs 1.9.249
headers. This can happen if you create metadata using an API like SOAP
documentation ( that supports more flexible metadata than the REST API. For example,
../../index.html) using SOAP, you can create metadata whose values are not legal HTTP
headers.
TABLE OF CONTENTS
object_lock_legal_hold_status
(../../guide/quickstart.html) The Legal Hold status for the specified object.
A Sample Tutorial
(../../guide/sqs.html) object_lock_mode
(string) --
Code Examples
(../../guide/examples.html) The object lock mode currently in place for this object.
User Guides object_lock_retain_until_date

(../../guide/index.html) (datetime) --
Available Services (index.html) The date and time when this object's object lock expires.
ACM (acm.html)
parts_count
ACMPCA (acm-pca.html) (integer) --
AlexaForBusiness The count of parts this object has.
Amplify (amplify.html) replication_status

(string) --
APIGateway
(apigateway.html)
request_charged
Api
request.
api.html)
restore
Boto 3 Docs 1.9.249
(string) --
documentation (
../../index.html) Provides information about object restoration operation and expiration
time of the restored object copy.
TABLE OF CONTENTS
server_side_encryption
(string) --
Quickstart
(../../guide/quickstart.html) The Server-side encryption algorithm used when storing this object in S3
(e.g., AES256, aws:kms).
A Sample Tutorial
(../../guide/sqs.html) sse_customer_algorithm
User Guides requested, the response will include this header confirming the encryption
(../../guide/index.html) algorithm used.
Available Services (index.html) sse_customer_key_md5


AlexaForBusiness
Amplify (amplify.html) ssekms_key_id

(string) --
APIGateway
(apigateway.html) If present, specifies the ID of the AWS Key Management Service (KMS)
Api
storage_class
version_id
Boto 3 Docs 1.9.249
(string) --
documentation (
../../index.html) Version of the object.
website_redirect_location
TABLE OF CONTENTS
(string) --
Quickstart If the bucket is configured as a website, redirects requests for this object
(../../guide/quickstart.html) to another object in the same bucket or to an external URL. Amazon S3
stores the value of this header in the object metadata.
A Sample Tutorial
(../../guide/sqs.html) Actions
Code Examples Actions call operations on resources. They may automatically handle the passing in
(../../guide/examples.html) of arguments set from identifiers and some attributes. For more information about
User Guides (../../guide/resources.html#actions-intro).
copy (CopySource, ExtraArgs=None, Callback=None, SourceClient=None,
Config=None)
ACM (acm.html) Copy an object from one S3 location to this object.
ACMPCA (acm-pca.html) This is a managed transfer which will perform a multipart copy in multiple
AlexaForBusiness threads if necessary.
(alexaforbusiness.html) Usage:
APIGateway
(apigateway.html)
Api
api.html)
../../index.html) copy_source = {
'Bucket': 'mybucket',
'Key': 'mykey'
TABLE OF CONTENTS
}
bucket = s3.Bucket('otherbucket')
Quickstart
obj = bucket.Object('otherkey')
obj.copy(copy_source)
A Sample Tutorial
Parameters
Code Examples
CopySource (dict) -- The name of the source bucket, key name of the
source object, and optional version ID of the source object. The dictionary
User Guides format is: {'Bucket': 'bucket', 'Key': 'key', 'VersionId': 'id'} .
(../../guide/index.html) Note that the VersionId key is optional and may be omitted.
Available Services (index.html) operation
ACM (acm.html) Callback (function) -- A method which takes a number of bytes
transferred to be periodically called during the copy.
AlexaForBusiness operation that may happen at the source object. For example, this client
(alexaforbusiness.html) is used for the head_object that determines the size of the copy. If no
client is provided, the current client is used as the client for the source
object.
Api
copy_from (**kwargs)
api.html)
Creates a copy of an object that is already stored in Amazon S3.
Boto 3 Docs 1.9.249
../../index.html)
Request Syntax
TABLE OF CONTENTS
Quickstart
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = object.copy_from(
../../index.html) CacheControl='string',
TABLE OF CONTENTS
Quickstart
A Sample Tutorial CopySourceIfModifiedSince=datetime(2015, 1, 1),
(../../guide/sqs.html) CopySourceIfNoneMatch='string',
Code Examples CopySourceIfUnmodifiedSince=datetime(2015, 1, 1),
(../../guide/examples.html) Expires=datetime(2015, 1, 1),
User Guides
GrantRead='string',
Available Services (index.html) GrantWriteACP='string',
Metadata={
ACM (acm.html)
'string': 'string'
AlexaForBusiness
(alexaforbusiness.html) TaggingDirective='COPY'|'REPLACE',
Amplify (amplify.html) StorageClass='STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|'ONEZON
APIGateway WebsiteRedirectLocation='string',
(apigateway.html) SSECustomerAlgorithm='string',
Api
api.html) CopySourceSSECustomerAlgorithm='string',
Boto 3 Docs 1.9.249
documentation ( Tagging='string',
../../index.html) ObjectLockMode='GOVERNANCE'|'COMPLIANCE',
TABLE OF CONTENTS ObjectLockLegalHoldStatus='ON'|'OFF'
)
Quickstart

(../../guide/sqs.html) ACL (string) -- The canned ACL to apply to the object.
Code Examples
User Guides the object.
(../../guide/index.html) ContentEncoding (string) -- Specifies what content encodings have been
Available Services (index.html) applied to obtain the media-type referenced by the Content-Type header
ACM (acm.html) field.
AlexaForBusiness the object data.
Api
may be omitted.
api.html)
Boto 3 Docs 1.9.249
(../../guide/quickstart.html) Expires (datetime) -- The date and time at which the object is no longer
cacheable.
A Sample Tutorial GrantFullControl (string) -- Gives the grantee READ, READ_ACP, and
(../../guide/sqs.html) WRITE_ACP permissions on the object.
Code Examples GrantRead (string) -- Allows grantee to read the object data and its
(../../guide/examples.html) metadata.
User Guides GrantWriteACP (string) -- Allows grantee to write the ACL for the
(../../guide/index.html) applicable object.
Metadata (dict) --
ACM (acm.html)
(string) --
ACMPCA (acm-pca.html) (string) --
MetadataDirective (string) -- Specifies whether the metadata is copied
AlexaForBusiness
from the source object or replaced with metadata provided in the
request.
Amplify (amplify.html) TaggingDirective (string) -- Specifies whether the object tag-set are
APIGateway copied from the source object or replaced with tag-set provided in the
(apigateway.html) request.
ApiGatewayManagement used when storing this object in S3 (e.g., AES256, aws:kms).
Api StorageClass (string) -- The type of storage to use for the object. Defaults
(apigatewaymanagement to 'STANDARD'.
api.html)
Boto 3 Docs 1.9.249
documentation ( bucket or to an external URL. Amazon S3 stores the value of this header
../../index.html) in the object metadata.
TABLE OF CONTENTS encrypting the object (e.g., AES256).
Quickstart key for Amazon S3 to use in encrypting data. This value is used to store
(../../guide/quickstart.html) the object and then it is discarded; Amazon does not store the encryption
A Sample Tutorial the x-amz-server-side-encryption-customer-algorithm header.
(../../guide/sqs.html) SSECustomerKeyMD5 (string) --
Code Examples Specifies the 128-bit MD5 digest of the encryption key according to RFC
(../../guide/examples.html) 1321. Amazon S3 uses this header for a message integrity check to
User Guides
Available Services (index.html) provided. Including this parameter is not required
ACM (acm.html)
ACMPCA (acm-pca.html) SSEKMSKeyId (string) -- Specifies the AWS KMS key ID to use for object
AlexaForBusiness
Amplify (amplify.html) http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-
signature-version
APIGateway
(apigateway.html)
signature-version)
ApiGatewayManagement SSEKMSEncryptionContext (string) -- Specifies the AWS KMS Encryption
Api Context to use for object encryption. The value of this header is a base64-
(apigatewaymanagement encoded UTF-8 string holding JSON with the encryption context key-value
api.html) pairs.
Boto 3 Docs 1.9.249
documentation ( CopySourceSSECustomerKey (string) -- Specifies the customer-provided
../../index.html) encryption key for Amazon S3 to use to decrypt the source object. The
TABLE OF CONTENTS the source object was created.
Quickstart Specifies the 128-bit MD5 digest of the encryption key according to RFC
(../../guide/quickstart.html) 1321. Amazon S3 uses this header for a message integrity check to
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
to the copied object.
APIGateway
(apigateway.html)
want the copied object's object lock to expire.
ApiGatewayManagement ObjectLockLegalHoldStatus (string) -- Specifies whether you want to
Api apply a Legal Hold to the copied object.
Return type
api.html)
dict
Boto 3 Docs 1.9.249
TABLE OF CONTENTS {
'CopyObjectResult': {
Quickstart 'ETag': 'string',
(../../guide/quickstart.html) 'LastModified': datetime(2015, 1, 1)
(../../guide/sqs.html) 'Expiration': 'string',
Code Examples
User Guides 'SSECustomerAlgorithm': 'string',
(../../guide/index.html) 'SSECustomerKeyMD5': 'string',
'SSEKMSEncryptionContext': 'string',
}
AlexaForBusiness
APIGateway CopyObjectResult (dict) --

(apigateway.html) ETag (string) --
ApiGatewayManagement LastModified (datetime) --
Api Expiration (string) --
(apigatewaymanagement If the object expiration is configured, the response includes this
api.html) header.
Boto 3 Docs 1.9.249
documentation ( VersionId (string) --
../../index.html) Version ID of the newly created copy.
TABLE OF CONTENTS
Quickstart
(../../guide/quickstart.html) SSECustomerAlgorithm (string) --
A Sample Tutorial If server-side encryption with a customer-provided encryption key was

(../../guide/sqs.html) requested, the response will include this header confirming the
Code Examples

(../../guide/index.html) requested, the response will include this header to provide round trip
ACM (acm.html)
ACMPCA (acm-pca.html) master encryption key that was used for the object.
AlexaForBusiness SSEKMSEncryptionContext (string) --
If present, specifies the AWS KMS Encryption Context to use for object
Amplify (amplify.html) encryption. The value of this header is a base64-encoded UTF-8 string
APIGateway holding JSON with the encryption context key-value pairs.
(apigateway.html) RequestCharged (string) --
ApiGatewayManagement If present, indicates that the requester was successfully charged for the
Api request.
api.html)
Boto 3 Docs 1.9.249 delete (**kwargs)
Removes the null version (if there is one) of an object and inserts a delete
documentation (
../../index.html) version, Amazon S3 does not remove any objects.

TABLE OF CONTENTS
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObject)

A Sample Tutorial response = object.delete(

(../../guide/sqs.html) MFA='string',
VersionId='string',
Code Examples
User Guides )

ACM (acm.html) MFA (string) -- The concatenation of the authentication device's serial
device.
AlexaForBusiness VersionId (string) -- VersionId used to reference a specific version of the
(alexaforbusiness.html) object.
Api
object lock should bypass governance-mode restrictions to process this
api.html)
operation.
Boto 3 Docs 1.9.249
dict
../../index.html)
Returns
Quickstart
Code Examples }

(dict) --
Available Services (index.html) DeleteMarker (boolean) --
ACM (acm.html) Specifies whether the versioned object that was permanently deleted
ACMPCA (acm-pca.html) was (true) or was not (false) a delete marker.
AlexaForBusiness VersionId (string) --

(alexaforbusiness.html) Returns the version ID of the delete marker created as a result of the
Amplify (amplify.html) DELETE operation.

Api
api.html) download_file (Filename, ExtraArgs=None, Callback=None, Config=None)
Download an S3 object to a file.
Boto 3 Docs 1.9.249
documentation ( Usage:
../../index.html)
import boto3
TABLE OF CONTENTS s3 = boto3.resource('s3')
s3.Object('mybucket', 'hello.txt').download_file('/tmp/hello.txt')
Quickstart
A Sample Tutorial parameters are capitalized. Detailed examples can be found at S3Transfer's
(../../guide/sqs.html) Usage.

(../../guide/examples.html) Filename (str) -- The path to the file to download to.
User Guides
operation.
Callback (function) -- A method which takes a number of bytes
Available Services (index.html) transferred to be periodically called during the download.
ACM (acm.html) (../customizations/s3.html#boto3.s3.transfer.TransferConfig)) -- The
ACMPCA (acm-pca.html) transfer configuration to be used when performing the transfer.
AlexaForBusiness
download_fileobj (Fileobj, ExtraArgs=None, Callback=None, Config=None)
Amplify (amplify.html) Download this object from S3 to a file-like object.
APIGateway The file-like object must be in binary mode.
(apigateway.html)
This is a managed transfer which will perform a multipart download in multiple
ApiGatewayManagement threads if necessary.
Api
Usage:
api.html)
../../index.html) bucket = s3.Bucket('mybucket')
obj = bucket.Object('mykey')
TABLE OF CONTENTS
obj.download_fileobj(data)
Quickstart

(../../guide/sqs.html) Fileobj (a file-like object) -- A file-like object to download into. At a
minimum, it must implement the write method and must accept bytes.
Code Examples
operation.
User Guides Callback (function) -- A method which takes a number of bytes
(../../guide/index.html) transferred to be periodically called during the download.
Available Services (index.html) (../customizations/s3.html#boto3.s3.transfer.TransferConfig)) -- The
ACM (acm.html) transfer configuration to be used when performing the download.
AlexaForBusiness get (**kwargs)

(alexaforbusiness.html) Retrieves objects from Amazon S3.
Amplify (amplify.html) See also: AWS API Documentation
APIGateway
Api
api.html)
Boto 3 Docs 1.9.249 response = object.get(
documentation ( IfMatch='string',
../../index.html) IfModifiedSince=datetime(2015, 1, 1),
TABLE OF CONTENTS
Range='string',
Quickstart
ResponseContentDisposition='string',
ResponseContentEncoding='string',
A Sample Tutorial ResponseContentLanguage='string',
(../../guide/sqs.html) ResponseContentType='string',
Code Examples ResponseExpires=datetime(2015, 1, 1),
(../../guide/examples.html) VersionId='string',
User Guides
Available Services (index.html) PartNumber=123
)
ACM (acm.html)
Parameters
AlexaForBusiness IfMatch (string) -- Return the object only if its entity tag (ETag) is the same
(alexaforbusiness.html) as the one specified, otherwise return a 412 (precondition failed).
Amplify (amplify.html) IfModifiedSince (datetime) -- Return the object only if it has been
APIGateway
(apigateway.html)
different from the one specified, otherwise return a 304 (not modified).
ApiGatewayManagement IfUnmodifiedSince (datetime) -- Return the object only if it has not been
Api modified since the specified time, otherwise return a 412 (precondition
(apigatewaymanagement failed).
api.html)
Boto 3 Docs 1.9.249
more information about the HTTP Range header, go to
documentation ( http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
../../index.html) (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35).
ResponseCacheControl (string) -- Sets the Cache-Control header of the
TABLE OF CONTENTS response.
ResponseContentDisposition (string) -- Sets the Content-Disposition
Quickstart header of the response
(../../guide/quickstart.html) ResponseContentEncoding (string) -- Sets the Content-Encoding header
of the response.
A Sample Tutorial ResponseContentLanguage (string) -- Sets the Content-Language header
(../../guide/sqs.html) of the response.
Code Examples ResponseContentType (string) -- Sets the Content-Type header of the
(../../guide/examples.html) response.
ResponseExpires (datetime) -- Sets the Expires header of the response.
User Guides VersionId (string) -- VersionId used to reference a specific version of the
(../../guide/index.html) object.
ACM (acm.html) SSECustomerKey (string) -- Specifies the customer-provided encryption
AlexaForBusiness key. The key must be appropriate for use with the algorithm specified in
(alexaforbusiness.html) the x-amz-server-side-encryption-customer-algorithm header.
Amplify (amplify.html) SSECustomerKeyMD5 (string) --
APIGateway 1321. Amazon S3 uses this header for a message integrity check to
(apigateway.html) ensure the encryption key was transmitted without error.
Api
api.html)
Boto 3 Docs 1.9.249
Quickstart positive integer between 1 and 10,000. Effectively performs a 'ranged'
(../../guide/quickstart.html) GET request for the part specified. Useful for downloading just a part of
an object.
A Sample Tutorial
dict
Code Examples
Response Syntax
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
TABLE OF CONTENTS
Quickstart
'ETag': 'string',
User Guides
ACM (acm.html)
'Metadata': {
AlexaForBusiness
},
Api
'TagCount': 123,
Boto 3 Docs 1.9.249
}
TABLE OF CONTENTS

(dict) --
A Sample Tutorial

response.
ACM (acm.html)
AlexaForBusiness

(apigateway.html)
Api
Boto 3 Docs 1.9.249

Quickstart
A Sample Tutorial
ACM (acm.html)
AlexaForBusiness
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249
TABLE OF CONTENTS


(string) --
AlexaForBusiness
(apigateway.html)
api.html)
Boto 3 Docs 1.9.249
documentation (
../../index.html)
request.
Quickstart
A Sample Tutorial

ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api Returns
api.html)
Return type
Boto 3 Docs 1.9.249
list of str
documentation (
../../index.html)
initiate_multipart_upload (**kwargs)
TABLE OF CONTENTS Initiates a multipart upload and returns an upload ID.
Quickstart
(../../guide/quickstart.html) Note: After you initiate multipart upload and upload one or more parts,
you must either complete or abort multipart upload in order to stop
A Sample Tutorial getting charged for storage of the uploaded parts. Only after you either
(../../guide/sqs.html) complete or abort multipart upload, Amazon S3 frees up the parts storage
Code Examples and stops charging you for the parts storage.

Request Syntax
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 multipart_upload = object.initiate_multipart_upload(
TABLE OF CONTENTS
Quickstart
Code Examples GrantWriteACP='string',
(../../guide/examples.html) Metadata={
'string': 'string'
User Guides
},
Available Services (index.html) StorageClass='STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|'ONEZON
ACM (acm.html)
ACMPCA (acm-pca.html) SSECustomerKey='string',
AlexaForBusiness
(alexaforbusiness.html) SSEKMSEncryptionContext='string',
Amplify (amplify.html) Tagging='string',
APIGateway ObjectLockMode='GOVERNANCE'|'COMPLIANCE',
(apigateway.html) ObjectLockRetainUntilDate=datetime(2015, 1, 1),
)
Api
api.html)
Parameters
Boto 3 Docs 1.9.249
documentation ( CacheControl (string) -- Specifies caching behavior along the
../../index.html) request/reply chain.
TABLE OF CONTENTS the object.
Quickstart applied to the object and thus what decoding mechanisms must be
(../../guide/quickstart.html) applied to obtain the media-type referenced by the Content-Type header
field.
A Sample Tutorial
Code Examples the object data.
(../../guide/examples.html) Expires (datetime) -- The date and time at which the object is no longer
cacheable.
User Guides GrantFullControl (string) -- Gives the grantee READ, READ_ACP, and
(../../guide/index.html) WRITE_ACP permissions on the object.
metadata.
ACM (acm.html) GrantReadACP (string) -- Allows grantee to read the object ACL.
ACMPCA (acm-pca.html) GrantWriteACP (string) -- Allows grantee to write the ACL for the
applicable object.
AlexaForBusiness Metadata (dict) --
(alexaforbusiness.html) A map of metadata to store with the object in S3.
(apigateway.html) ServerSideEncryption (string) -- The Server-side encryption algorithm
Api
to 'STANDARD'.
api.html)
Boto 3 Docs 1.9.249
documentation ( SSECustomerAlgorithm (string) -- Specifies the algorithm to use to when
../../index.html) encrypting the object (e.g., AES256).
TABLE OF CONTENTS key for Amazon S3 to use in encrypting data. This value is used to store
Quickstart key. The key must be appropriate for use with the algorithm specified in
(../../guide/quickstart.html) the x-amz-server-side-encryption-customer-algorithm header.
A Sample Tutorial Specifies the 128-bit MD5 digest of the encryption key according to RFC
(../../guide/sqs.html) 1321. Amazon S3 uses this header for a message integrity check to
Code Examples ensure the encryption key was transmitted without error.
User Guides Please note that this parameter is automatically populated if it is not
(../../guide/index.html) provided. Including this parameter is not required

ACM (acm.html)
ACMPCA (acm-pca.html) will fail if not made via SSL or using SigV4. Documentation on configuring
AlexaForBusiness
signature-version
Amplify (amplify.html) (http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify
signature-version)
APIGateway
(apigateway.html)
ApiGatewayManagement encoded UTF-8 string holding JSON with the encryption context key-value
Api pairs.
(apigatewaymanagement RequestPayer (string) -- Confirms that the requester knows that she or
api.html) he will be charged for the request. Bucket owners need not specify this
Boto 3 Docs 1.9.249
documentation ( http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
../../index.html) (http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
TABLE OF CONTENTS as URL Query parameters
ObjectLockMode (string) -- Specifies the object lock mode that you want
Quickstart to apply to the uploaded object.
(../../guide/quickstart.html) ObjectLockRetainUntilDate (datetime) -- Specifies the date and time
when you want the object lock to expire.
A Sample Tutorial ObjectLockLegalHoldStatus (string) -- Specifies whether you want to
(../../guide/sqs.html) apply a Legal Hold to the uploaded object.
(../../guide/examples.html) s3.MultipartUpload
User Guides Returns
(../../guide/index.html) MultipartUpload resource
ACM (acm.html) load ()

ACMPCA (acm-pca.html) Calls S3.Client.head_object() to update the attributes of the Object resource.
Note that the load and reload methods are the same method and can be used
AlexaForBusiness
interchangeably.
APIGateway
Request Syntax
(apigateway.html)
object.load()
Api
api.html) Returns
None
Boto 3 Docs 1.9.249
documentation (
../../index.html) put (**kwargs)
TABLE OF CONTENTS
Quickstart
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = object.put(
TABLE OF CONTENTS
Quickstart
ContentLength=123,
User Guides
Metadata={
Available Services (index.html) 'string': 'string'
},
ACM (acm.html)
ACMPCA (acm-pca.html) StorageClass='STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|'ONEZON
AlexaForBusiness
(alexaforbusiness.html) SSECustomerAlgorithm='string',
Amplify (amplify.html) SSEKMSKeyId='string',
APIGateway SSEKMSEncryptionContext='string',
Tagging='string',
Api
api.html)
Boto 3 Docs 1.9.249
)
documentation (
../../index.html)
Parameters
TABLE OF CONTENTS
User Guides field.
ACM (acm.html)
the object data.
Api metadata.
api.html)
Boto 3 Docs 1.9.249
applicable object.
documentation ( Metadata (dict) --
../../index.html) A map of metadata to store with the object in S3.
(string) --
Quickstart used when storing this object in S3 (e.g., AES256, aws:kms).
(../../guide/quickstart.html) StorageClass (string) -- The type of storage to use for the object. Defaults
A Sample Tutorial to 'STANDARD'.
(../../guide/sqs.html) WebsiteRedirectLocation (string) -- If the bucket is configured as a
Code Examples bucket or to an external URL. Amazon S3 stores the value of this header
(../../guide/examples.html) in the object metadata.
User Guides
Available Services (index.html) key for Amazon S3 to use in encrypting data. This value is used to store
ACM (acm.html)
ACMPCA (acm-pca.html) the x-amz-server-side-encryption-customer-algorithm header.
AlexaForBusiness
Amplify (amplify.html) ensure the encryption key was transmitted without error.
APIGateway
(apigateway.html)
ApiGatewayManagement provided. Including this parameter is not required
Api
api.html)
Boto 3 Docs 1.9.249
documentation ( will fail if not made via SSL or using SigV4. Documentation on configuring
../../index.html) any of the officially supported AWS SDKs and CLI can be found at
TABLE OF CONTENTS signature-version
Quickstart signature-version)
(../../guide/quickstart.html) SSEKMSEncryptionContext (string) -- Specifies the AWS KMS Encryption
A Sample Tutorial encoded UTF-8 string holding JSON with the encryption context key-value
(../../guide/sqs.html) pairs.
Code Examples RequestPayer (string) -- Confirms that the requester knows that she or
(../../guide/examples.html) he will be charged for the request. Bucket owners need not specify this
User Guides from requester pays buckets can be found at
(../../guide/index.html) http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
ACM (acm.html) as URL Query parameters. (For example, "Key1=Value1")
ObjectLockMode (string) -- The object lock mode that you want to apply
to this object.
AlexaForBusiness ObjectLockRetainUntilDate (datetime) -- The date and time when you
(alexaforbusiness.html) want this object's object lock to expire.
Amplify (amplify.html) ObjectLockLegalHoldStatus (string) -- The Legal Hold status that you
APIGateway
dict
Api Returns
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'Expiration': 'string',
TABLE OF CONTENTS
Quickstart
A Sample Tutorial 'RequestCharged': 'requester'
Code Examples
Response Structure
ACM (acm.html) date (expiry-date) and rule ID (rule-id). The value of rule-id is URL
encoded.
AlexaForBusiness
ETag (string) --
(alexaforbusiness.html) Entity tag for the uploaded object.
Amplify (amplify.html) ServerSideEncryption (string) --
APIGateway The Server-side encryption algorithm used when storing this object in
(apigateway.html) S3 (e.g., AES256, aws:kms).
Api
Version of the object.
api.html) SSECustomerAlgorithm (string) --
Boto 3 Docs 1.9.249
documentation ( encryption algorithm used.
../../index.html)
TABLE OF CONTENTS If server-side encryption with a customer-provided encryption key was

Quickstart
(../../guide/quickstart.html) SSEKMSKeyId (string) --
A Sample Tutorial If present, specifies the ID of the AWS Key Management Service (KMS)
(../../guide/sqs.html) master encryption key that was used for the object.
Code Examples SSEKMSEncryptionContext (string) --
User Guides encryption. The value of this header is a base64-encoded UTF-8 string
(../../guide/index.html) holding JSON with the encryption context key-value pairs.
Available Services (index.html) RequestCharged (string) --
ACM (acm.html) If present, indicates that the requester was successfully charged for the
request.
AlexaForBusiness
(alexaforbusiness.html) reload ()
Calls S3.Client.head_object() to update the attributes of the Object resource.
Note that the load and reload methods are the same method and can be used
APIGateway interchangeably.
(apigateway.html)
ApiGatewayManagement (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/None)
Api
Request Syntax
api.html)
Boto 3 Docs 1.9.249 object.reload()
documentation (
None
TABLE OF CONTENTS
Quickstart restore_object (**kwargs)

(../../guide/quickstart.html) Restores an archived copy of an object back into Amazon S3
A Sample Tutorial See also: AWS API Documentation
(../../guide/sqs.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreObject)
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = object.restore_object(
documentation ( VersionId='string',
../../index.html) RestoreRequest={
'Days': 123,
TABLE OF CONTENTS
},
Quickstart
'Type': 'SELECT',
'Tier': 'Standard'|'Bulk'|'Expedited',
A Sample Tutorial 'Description': 'string',
(../../guide/sqs.html) 'SelectParameters': {
Code Examples 'InputSerialization': {
(../../guide/examples.html) 'CSV': {
User Guides
Available Services (index.html) 'RecordDelimiter': 'string',
'FieldDelimiter': 'string',
ACM (acm.html)
ACMPCA (acm-pca.html) 'AllowQuotedRecordDelimiter': True|False
},
AlexaForBusiness
(alexaforbusiness.html) 'CompressionType': 'NONE'|'GZIP'|'BZIP2',
'JSON': {
Amplify (amplify.html) 'Type': 'DOCUMENT'|'LINES'
APIGateway },
(apigateway.html) 'Parquet': {}
},
Api
api.html) 'Expression': 'string',
'OutputSerialization': {
Boto 3 Docs 1.9.249
'CSV': {
documentation ( 'QuoteFields': 'ALWAYS'|'ASNEEDED',
../../index.html) 'QuoteEscapeCharacter': 'string',
TABLE OF CONTENTS 'FieldDelimiter': 'string',
'QuoteCharacter': 'string'
Quickstart },
(../../guide/quickstart.html) 'JSON': {
A Sample Tutorial
}
}
Code Examples },
(../../guide/examples.html) 'OutputLocation': {
User Guides 'S3': {
(../../guide/index.html) 'BucketName': 'string',
'Prefix': 'string',
Available Services (index.html) 'Encryption': {
ACM (acm.html) 'EncryptionType': 'AES256'|'aws:kms',
'KMSKeyId': 'string',
'KMSContext': 'string'
AlexaForBusiness },
(alexaforbusiness.html) 'CannedACL': 'private'|'public-read'|'public-read-writ
Amplify (amplify.html) 'AccessControlList': [
{
APIGateway 'Grantee': {
(apigateway.html)
ApiGatewayManagement 'EmailAddress': 'string',
Api 'ID': 'string',
(apigatewaymanagement 'Type': 'CanonicalUser'|'AmazonCustomerByE
api.html) 'URI': 'string'
},
Boto 3 Docs 1.9.249
'Permission': 'FULL_CONTROL'|'WRITE'|'WRITE_AC
documentation ( },
'Tagging': {
TABLE OF CONTENTS 'TagSet': [
{
Quickstart 'Key': 'string',
(../../guide/quickstart.html) 'Value': 'string'
},
A Sample Tutorial
]
},
Code Examples 'UserMetadata': [
User Guides 'Name': 'string',
},
ACM (acm.html) 'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'STAND
}
}
AlexaForBusiness },
(alexaforbusiness.html) RequestPayer='requester'
APIGateway
(apigateway.html)
Parameters
Api RestoreRequest (dict) --
api.html)
Boto 3 Docs 1.9.249
OutputLocation.
documentation (
../../index.html)
Glacier related parameters pertaining to this job. Do not use with
restores that specify OutputLocation.
TABLE OF CONTENTS
Tier (string) -- [REQUIRED]
Glacier retrieval tier at which the restore will be processed.
Quickstart
Type of restore request.
A Sample Tutorial
(../../guide/sqs.html) Tier (string) --
Code Examples
(../../guide/examples.html) Description (string) --
User Guides
(../../guide/index.html) SelectParameters (dict) --
Describes the parameters for Select job types.
InputSerialization (dict) -- [REQUIRED]
ACM (acm.html) Describes the serialization format of the object.
ACMPCA (acm-pca.html) CSV (dict) --
AlexaForBusiness Describes the serialization of a CSV-encoded object.
(alexaforbusiness.html) FileHeaderInfo (string) --
Amplify (amplify.html) Describes the first line of input. Valid values: None, Ignore, Use.
APIGateway Comments (string) --

(apigateway.html) The single character used to indicate a row should be ignored
when present at the start of a row.
Api QuoteEscapeCharacter (string) --
(apigatewaymanagement The single character used for escaping the quote character
api.html) inside an already escaped value.
Boto 3 Docs 1.9.249
documentation (
../../index.html)
TABLE OF CONTENTS QuoteCharacter (string) --

value.
Quickstart
(../../guide/quickstart.html) AllowQuotedRecordDelimiter (boolean) --
A Sample Tutorial
FALSE. Setting this value to TRUE may lower performance.
Code Examples
Specifies object's compression format. Valid values: NONE, GZIP,
User Guides BZIP2. Default Value: NONE.
JSON (dict) --
Available Services (index.html) Specifies JSON as object's input serialization format.
ACM (acm.html) Type (string) --

The type of JSON. Valid values: Document, Lines.
Parquet (dict) --
AlexaForBusiness Specifies Parquet as object's input serialization format.
ExpressionType (string) -- [REQUIRED]
Amplify (amplify.html) The type of the provided expression (e.g., SQL).
APIGateway Expression (string) -- [REQUIRED]
(apigateway.html) The expression that is used to query the object.
ApiGatewayManagement OutputSerialization (dict) -- [REQUIRED]
Api Describes how the results of the Select job are serialized.
api.html) CSV (dict) --
Boto 3 Docs 1.9.249
documentation ( QuoteFields (string) --
../../index.html)
TABLE OF CONTENTS Th single character used for escaping the quote character inside
Quickstart RecordDelimiter (string) --
(../../guide/quickstart.html) The value used to separate individual records.
A Sample Tutorial FieldDelimiter (string) --
(../../guide/sqs.html) The value used to separate individual fields in a record.
Code Examples QuoteCharacter (string) --
(../../guide/examples.html) The value used for escaping where the field delimiter is part of
the value.
User Guides
(../../guide/index.html) JSON (dict) --
Specifies JSON as request's output serialization format.
ACM (acm.html) The value used to separate individual records in the output.
ACMPCA (acm-pca.html) OutputLocation (dict) --
AlexaForBusiness Describes the location where the restore job's output is stored.
(alexaforbusiness.html) S3 (dict) --
Amplify (amplify.html) Describes an S3 location that will receive the results of the restore
request.
APIGateway
(apigateway.html) BucketName (string) -- [REQUIRED]
The name of the bucket where the restore results will be placed.
Api Prefix (string) -- [REQUIRED]
(apigatewaymanagement The prefix that is prepended to the restore results for this request.
api.html) Encryption (dict) --
Boto 3 Docs 1.9.249
documentation ( results in Amazon S3 (e.g., AES256, aws:kms).
../../index.html)
TABLE OF CONTENTS the AWS KMS key ID to use for encryption of job results.
Quickstart
to specify the encryption context for the restore results.
A Sample Tutorial
The canned ACL to apply to the restore results.
Code Examples
A list of grants that control access to the staged results.
User Guides
(dict) --
Grantee (dict) --
Available Services (index.html) DisplayName (string) --
ACM (acm.html)
ACMPCA (acm-pca.html) Email address of the grantee.
AlexaForBusiness ID (string) --
(alexaforbusiness.html) The canonical user ID of the grantee.
Amplify (amplify.html) Type (string) -- [REQUIRED]
APIGateway Type of grantee
(apigateway.html) URI (string) --
ApiGatewayManagement URI of the grantee group.
Api Permission (string) --
(apigatewaymanagement Specifies the permission given to the grantee.
api.html)
Tagging (dict) --
Boto 3 Docs 1.9.249
documentation (
../../index.html)
(dict) --
Quickstart
Value of the tag.
A Sample Tutorial
(dict) --
Code Examples
Name (string) --
User Guides
Value (string) --
Available Services (index.html) The class of storage used to store the restore results.
ACM (acm.html) RequestPayer (string) -- Confirms that the requester knows that she or
ACMPCA (acm-pca.html) parameter in their requests. Documentation on downloading objects
AlexaForBusiness from requester pays buckets can be found at
(alexaforbusiness.html) http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
Return type
APIGateway
dict
(apigateway.html)
Returns
Api Response Syntax
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'RequestCharged': 'requester',
../../index.html) 'RestoreOutputPath': 'string'
}
TABLE OF CONTENTS
Response Structure
Quickstart
(dict) --
A Sample Tutorial
request.
Code Examples
(../../guide/examples.html) RestoreOutputPath (string) --
User Guides Indicates the path in the provided S3 output location where Select
(../../guide/index.html) results will be restored to.
ACM (acm.html) upload_file (Filename, ExtraArgs=None, Callback=None, Config=None)

Usage:
AlexaForBusiness
import boto3
APIGateway s3.Object('mybucket', 'hello.txt').upload_file('/tmp/hello.txt')
(apigateway.html)
ApiGatewayManagement Similar behavior as S3Transfer's upload_file() method, except that parameters

Api are capitalized. Detailed examples can be found at S3Transfer's Usage.
Filename (str) -- The path to the file to upload.
Boto 3 Docs 1.9.249
documentation ( operation.
../../index.html) Callback (function) -- A method which takes a number of bytes
transferred to be periodically called during the upload.
TABLE OF CONTENTS Config (boto3.s3.transfer.TransferConfig
Quickstart transfer configuration to be used when performing the transfer.
A Sample Tutorial upload_fileobj (Fileobj, ExtraArgs=None, Callback=None, Config=None)

Upload a file-like object to this object.
Code Examples
This is a managed transfer which will perform a multipart upload in multiple
User Guides threads if necessary.
Usage:
ACM (acm.html) import boto3

ACMPCA (acm-pca.html) s3 = boto3.resource('s3')
bucket = s3.Bucket('mybucket')
AlexaForBusiness
obj = bucket.Object('mykey')
Amplify (amplify.html) with open('filename', 'rb') as data:

obj.upload_fileobj(data)
APIGateway
(apigateway.html)
Api Fileobj (a file-like object) -- A file-like object to upload. At a minimum, it
(apigatewaymanagement must implement the read method, and must return bytes.
api.html)
Boto 3 Docs 1.9.249
operation.
documentation ( Callback (function) -- A method which takes a number of bytes
../../index.html) transferred to be periodically called during the upload.
TABLE OF CONTENTS (../customizations/s3.html#boto3.s3.transfer.TransferConfig)) -- The
transfer configuration to be used when performing the upload.
Quickstart
Sub-resources
A Sample Tutorial Sub-resources are methods that create a new instance of a child resource. This
(../../guide/sqs.html) resource's identifiers get passed along to the child. For more information about
Code Examples sub-resources refer to the Resources Introduction Guide
(../../guide/examples.html) (../../guide/resources.html#subresources-intro).
User Guides Acl ()

(../../guide/index.html) Creates a ObjectAcl resource.:

object_acl = object.Acl()
ACM (acm.html)
Return type
AlexaForBusiness S3.ObjectAcl
Returns
A ObjectAcl resource
APIGateway
(apigateway.html)
Bucket ()
Api Creates a Bucket resource.:
api.html)
Boto 3 Docs 1.9.249 bucket = object.Bucket()
documentation (
S3.Bucket
TABLE OF CONTENTS
Returns
A Sample Tutorial MultipartUpload (id)

Creates a MultipartUpload resource.:
Code Examples
multipart_upload = object.MultipartUpload('id')
User Guides
Parameters
Available Services (index.html) id (string) -- The MultipartUpload's id identifier. This must be set.
ACMPCA (acm-pca.html) S3.MultipartUpload
(alexaforbusiness.html) A MultipartUpload resource
APIGateway Version (id)

(apigateway.html) Creates a ObjectVersion resource.:
Api object_version = object.Version('id')
api.html)
Parameters
Boto 3 Docs 1.9.249
id (string) -- The Version's id identifier. This must be set.
documentation (
S3.ObjectVersion

Quickstart
Waiters
A Sample Tutorial
Code Examples (../../guide/resources.html#waiters-intro).
wait_until_exists (**kwargs)
User Guides Waits until this Object is exists. This method calls
(../../guide/index.html) S3.Waiter.object_exists.wait() which polls. S3.Client.head_object() every
Available Services (index.html) 5 seconds until a successful state is reached. An error is returned after 20 failed
checks.
ACM (acm.html)
ACMPCA (acm-pca.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadObject)
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 object.wait_until_exists(
TABLE OF CONTENTS
Range='string',
VersionId='string',
Quickstart
A Sample Tutorial RequestPayer='requester',
(../../guide/sqs.html) PartNumber=123
Code Examples )

(../../guide/index.html) IfMatch (string) -- Return the object only if its entity tag (ETag) is the same
ACM (acm.html) modified since the specified time, otherwise return a 304 (not modified).
AlexaForBusiness IfUnmodifiedSince (datetime) -- Return the object only if it has not been
(alexaforbusiness.html) modified since the specified time, otherwise return a 412 (precondition
failed).
APIGateway more information about the HTTP Range header, go to
(apigateway.html) http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
Api
object.
api.html)
Boto 3 Docs 1.9.249
documentation ( SSECustomerKey (string) -- Specifies the customer-provided encryption
../../index.html) key for Amazon S3 to use in encrypting data. This value is used to store
TABLE OF CONTENTS key. The key must be appropriate for use with the algorithm specified in
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
Amplify (amplify.html) HEAD request for the part specified. Useful querying about the size of the
APIGateway
Api
api.html) wait_until_not_exists (**kwargs)
Waits until this Object is not exists. This method calls
Boto 3 Docs 1.9.249
S3.Waiter.object_not_exists.wait() which polls. S3.Client.head_object()
documentation ( every 5 seconds until a successful state is reached. An error is returned after 20
../../index.html) failed checks.
TABLE OF CONTENTS (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadObject)
Request Syntax
Quickstart
A Sample Tutorial object.wait_until_not_exists(

(../../guide/sqs.html) IfMatch='string',
Code Examples
User Guides Range='string',
(../../guide/index.html) VersionId='string',
ACM (acm.html) RequestPayer='requester',
PartNumber=123
)
AlexaForBusiness
Parameters
APIGateway as the one specified, otherwise return a 412 (precondition failed).
(apigateway.html) IfModifiedSince (datetime) -- Return the object only if it has been
Api
api.html)
Boto 3 Docs 1.9.249
../../index.html) Range (string) -- Downloads the specified range bytes of an object. For
TABLE OF CONTENTS http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
Quickstart VersionId (string) -- VersionId used to reference a specific version of the
(../../guide/quickstart.html) object.
User Guides the x-amz-server-side-encryption-customer-algorithm header.
(../../guide/index.html) SSECustomerKeyMD5 (string) --
ACM (acm.html) ensure the encryption key was transmitted without error.
AlexaForBusiness Please note that this parameter is automatically populated if it is not

(alexaforbusiness.html) provided. Including this parameter is not required
APIGateway
(apigateway.html)
ApiGatewayManagement from requester pays buckets can be found at
Api http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
(apigatewaymanagement (http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
api.html)
Boto 3 Docs 1.9.249
Returns
TABLE OF CONTENTS
None
Quickstart
A Sample Tutorial ObjectAcl

Code Examples class S3. ObjectAcl (bucket_name, object_key)

(../../guide/examples.html) A resource representing an Amazon Simple Storage Service (S3) ObjectAcl:
User Guides
(../../guide/index.html) import boto3

ACM (acm.html) object_acl = s3.ObjectAcl('bucket_name','object_key')
(alexaforbusiness.html) bucket_name (string) -- The ObjectAcl's bucket_name identifier. This must be
set.
object_key (string) -- The ObjectAcl's object_key identifier. This must be set.
APIGateway
(apigateway.html) These are the resource's available identifiers:
ApiGatewayManagement bucket_name
Api object_key
api.html)
grants
Boto 3 Docs 1.9.249
owner
documentation ( request_charged
../../index.html)

load()
Quickstart put()

Object()
Code Examples
Identifiers

(string) The ObjectAcl's bucket_name identifier. This must be set.
ACM (acm.html)
ACMPCA (acm-pca.html) object_key

(string) The ObjectAcl's object_key identifier. This must be set.
AlexaForBusiness
Attributes
Amplify (amplify.html) Attributes provide access to the properties of a resource. Attributes are lazy-loaded
APIGateway the first time one is accessed via the load() method. For more information about
(apigateway.html) attributes refer to the Resources Introduction Guide
Api grants
(apigatewaymanagement (list) --
api.html)
A list of grants.
(dict) --
Boto 3 Docs 1.9.249
documentation ( Grantee (dict) --
../../index.html) DisplayName (string) --

TABLE OF CONTENTS
Quickstart Email address of the grantee.

ID (string) --
A Sample Tutorial
Type (string) --
Code Examples
(../../guide/examples.html) Type of grantee
User Guides URI (string) --

(../../guide/index.html) URI of the grantee group.
Available Services (index.html) Permission (string) --
ACM (acm.html) Specifies the permission given to the grantee.
owner
APIGateway request_charged
Api request.
api.html) Actions
Boto 3 Docs 1.9.249
documentation ( actions refer to the Resources Introduction Guide
../../index.html) (../../guide/resources.html#actions-intro).
TABLE OF CONTENTS
Quickstart Returns
(../../guide/quickstart.html) A list containing the name of each sub-resource for this resource
Code Examples
load ()
User Guides
Calls S3.Client.get_object_acl() to update the attributes of the ObjectAcl
Available Services (index.html) be used interchangeably.

Request Syntax
AlexaForBusiness
object_acl.load()
APIGateway
Returns
(apigateway.html)
None
Api
(apigatewaymanagement put (**kwargs)
api.html)
uses the acl subresource to set the access control list (ACL) permissions for an
Boto 3 Docs 1.9.249
object that already exists in a bucket
documentation (
../../index.html)
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectAcl)
Quickstart
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = object_acl.put(
'Grants': [
{
TABLE OF CONTENTS
'Grantee': {
Quickstart
'ID': 'string',
Code Examples },
},
User Guides
],
'Owner': {
'ID': 'string'
ACM (acm.html)
}
AlexaForBusiness
(alexaforbusiness.html) GrantRead='string',
Amplify (amplify.html) GrantWrite='string',
APIGateway GrantWriteACP='string',
VersionId='string'
)
Api
api.html)
Parameters
Boto 3 Docs 1.9.249
documentation (
../../index.html) Contains the elements that set the ACL permissions for an object per
grantee.
TABLE OF CONTENTS
Grants (list) --
A list of grants.
Quickstart
Grantee (dict) --
A Sample Tutorial DisplayName (string) --
(../../guide/sqs.html) Screen name of the grantee.
Code Examples EmailAddress (string) --
(../../guide/examples.html) Email address of the grantee.
User Guides ID (string) --
(../../guide/index.html) The canonical user ID of the grantee.
Available Services (index.html) Type (string) -- [REQUIRED]

Type of grantee
ACM (acm.html)
URI (string) --
AlexaForBusiness
Owner (dict) --
APIGateway Container for the bucket owner's display name and ID.
(apigateway.html)
Boto 3 Docs 1.9.249
applicable bucket.
TABLE OF CONTENTS RequestPayer (string) -- Confirms that the requester knows that she or
Quickstart parameter in their requests. Documentation on downloading objects
(../../guide/quickstart.html) from requester pays buckets can be found at
A Sample Tutorial (http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
(../../guide/sqs.html) VersionId (string) -- VersionId used to reference a specific version of the
Code Examples object.
User Guides dict
Available Services (index.html) Response Syntax
ACM (acm.html)
{
AlexaForBusiness }
Response Structure
APIGateway
(dict) --
(apigateway.html)
Api If present, indicates that the requester was successfully charged for the
(apigatewaymanagement request.
api.html)
Boto 3 Docs 1.9.249 reload ()
documentation ( Calls S3.Client.get_object_acl() to update the attributes of the ObjectAcl

../../index.html)

A Sample Tutorial object_acl.reload()


None
User Guides
Sub-resources
Available Services (index.html) Sub-resources are methods that create a new instance of a child resource. This
ACM (acm.html)
ACMPCA (acm-pca.html) (../../guide/resources.html#subresources-intro).
AlexaForBusiness Object ()
APIGateway object = object_acl.Object()

(apigateway.html)

Api
S3.Object
api.html) Returns
A Object resource
Boto 3 Docs 1.9.249
documentation (
../../index.html)
ObjectSummary
TABLE OF CONTENTS
class S3. ObjectSummary (bucket_name, key)

Quickstart
A resource representing an Amazon Simple Storage Service (S3) ObjectSummary:
A Sample Tutorial
Code Examples s3 = boto3.resource('s3')

object_summary = s3.ObjectSummary('bucket_name','key')
User Guides
Parameters
Available Services (index.html) bucket_name (string) -- The ObjectSummary's bucket_name identifier. This
must be set.
ACM (acm.html)
key (string) -- The ObjectSummary's key identifier. This must be set.
AlexaForBusiness
(alexaforbusiness.html) bucket_name
key
APIGateway
(apigateway.html) e_tag
last_modified
owner
Api
size
api.html) storage_class
Boto 3 Docs 1.9.249
documentation ( copy_from()
delete()
../../index.html)
get()
TABLE OF CONTENTS
initiate_multipart_upload()
load()
Quickstart
put()
restore_object()
A Sample Tutorial
Acl()
Code Examples
Bucket()
MultipartUpload()
User Guides Object()
(../../guide/index.html) Version()
Available Services (index.html) These are the resource's available waiters:
ACM (acm.html) wait_until_exists()

wait_until_not_exists()
Identifiers
AlexaForBusiness
Amplify (amplify.html) Introduction Guide (../../guide/resources.html#identifiers-attributes-intro).
APIGateway bucket_name
(apigateway.html)
(string) The ObjectSummary's bucket_name identifier. This must be set.
Api key
(apigatewaymanagement (string) The ObjectSummary's key identifier. This must be set.
api.html)
Attributes
Boto 3 Docs 1.9.249
documentation ( the first time one is accessed via the load() method. For more information about
../../index.html) attributes refer to the Resources Introduction Guide
TABLE OF CONTENTS
e_tag
(string) --
Quickstart
last_modified
A Sample Tutorial (datetime) --
owner
Code Examples
User Guides ID (string) --
size
(integer) --
ACM (acm.html)
storage_class
(string) --
AlexaForBusiness
Amplify (amplify.html) Actions

APIGateway Actions call operations on resources. They may automatically handle the passing in
(apigateway.html) of arguments set from identifiers and some attributes. For more information about
Api
(apigatewaymanagement copy_from (**kwargs)
api.html) Creates a copy of an object that is already stored in Amazon S3.
Boto 3 Docs 1.9.249
documentation (
Request Syntax
../../index.html)
TABLE OF CONTENTS
Quickstart
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = object_summary.copy_from(
TABLE OF CONTENTS
Quickstart
A Sample Tutorial CopySourceIfModifiedSince=datetime(2015, 1, 1),
(../../guide/sqs.html) CopySourceIfNoneMatch='string',
Code Examples CopySourceIfUnmodifiedSince=datetime(2015, 1, 1),
(../../guide/examples.html) Expires=datetime(2015, 1, 1),
User Guides
GrantRead='string',
Available Services (index.html) GrantWriteACP='string',
Metadata={
ACM (acm.html)
'string': 'string'
AlexaForBusiness
(alexaforbusiness.html) TaggingDirective='COPY'|'REPLACE',
Amplify (amplify.html) StorageClass='STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|'ONEZON
APIGateway WebsiteRedirectLocation='string',
(apigateway.html) SSECustomerAlgorithm='string',
Api
api.html) CopySourceSSECustomerAlgorithm='string',
Boto 3 Docs 1.9.249
documentation ( Tagging='string',
../../index.html) ObjectLockMode='GOVERNANCE'|'COMPLIANCE',
TABLE OF CONTENTS ObjectLockLegalHoldStatus='ON'|'OFF'
)
Quickstart

(../../guide/sqs.html) ACL (string) -- The canned ACL to apply to the object.
Code Examples
User Guides the object.
(../../guide/index.html) ContentEncoding (string) -- Specifies what content encodings have been
Available Services (index.html) applied to obtain the media-type referenced by the Content-Type header
ACM (acm.html) field.
AlexaForBusiness the object data.
Api
may be omitted.
api.html)
Boto 3 Docs 1.9.249
(../../guide/quickstart.html) Expires (datetime) -- The date and time at which the object is no longer
cacheable.
A Sample Tutorial GrantFullControl (string) -- Gives the grantee READ, READ_ACP, and
(../../guide/sqs.html) WRITE_ACP permissions on the object.
Code Examples GrantRead (string) -- Allows grantee to read the object data and its
(../../guide/examples.html) metadata.
User Guides GrantWriteACP (string) -- Allows grantee to write the ACL for the
(../../guide/index.html) applicable object.
Metadata (dict) --
ACM (acm.html)
(string) --
ACMPCA (acm-pca.html) (string) --
MetadataDirective (string) -- Specifies whether the metadata is copied
AlexaForBusiness
from the source object or replaced with metadata provided in the
request.
Amplify (amplify.html) TaggingDirective (string) -- Specifies whether the object tag-set are
APIGateway copied from the source object or replaced with tag-set provided in the
(apigateway.html) request.
ApiGatewayManagement used when storing this object in S3 (e.g., AES256, aws:kms).
Api StorageClass (string) -- The type of storage to use for the object. Defaults
(apigatewaymanagement to 'STANDARD'.
api.html)
Boto 3 Docs 1.9.249
documentation ( bucket or to an external URL. Amazon S3 stores the value of this header
../../index.html) in the object metadata.
TABLE OF CONTENTS encrypting the object (e.g., AES256).
Quickstart key for Amazon S3 to use in encrypting data. This value is used to store
(../../guide/quickstart.html) the object and then it is discarded; Amazon does not store the encryption
A Sample Tutorial the x-amz-server-side-encryption-customer-algorithm header.
(../../guide/sqs.html) SSECustomerKeyMD5 (string) --
Code Examples Specifies the 128-bit MD5 digest of the encryption key according to RFC
(../../guide/examples.html) 1321. Amazon S3 uses this header for a message integrity check to
User Guides
Available Services (index.html) provided. Including this parameter is not required
ACM (acm.html)
ACMPCA (acm-pca.html) SSEKMSKeyId (string) -- Specifies the AWS KMS key ID to use for object
AlexaForBusiness
Amplify (amplify.html) http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-
signature-version
APIGateway
(apigateway.html)
signature-version)
ApiGatewayManagement SSEKMSEncryptionContext (string) -- Specifies the AWS KMS Encryption
Api Context to use for object encryption. The value of this header is a base64-
(apigatewaymanagement encoded UTF-8 string holding JSON with the encryption context key-value
api.html) pairs.
Boto 3 Docs 1.9.249
documentation ( CopySourceSSECustomerKey (string) -- Specifies the customer-provided
../../index.html) encryption key for Amazon S3 to use to decrypt the source object. The
TABLE OF CONTENTS the source object was created.
Quickstart Specifies the 128-bit MD5 digest of the encryption key according to RFC
(../../guide/quickstart.html) 1321. Amazon S3 uses this header for a message integrity check to
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
to the copied object.
APIGateway
(apigateway.html)
want the copied object's object lock to expire.
ApiGatewayManagement ObjectLockLegalHoldStatus (string) -- Specifies whether you want to
Api apply a Legal Hold to the copied object.
Return type
api.html)
dict
Boto 3 Docs 1.9.249
TABLE OF CONTENTS {
'CopyObjectResult': {
Quickstart 'ETag': 'string',
(../../guide/quickstart.html) 'LastModified': datetime(2015, 1, 1)
(../../guide/sqs.html) 'Expiration': 'string',
Code Examples
User Guides 'SSECustomerAlgorithm': 'string',
(../../guide/index.html) 'SSECustomerKeyMD5': 'string',
}
AlexaForBusiness
APIGateway CopyObjectResult (dict) --

(apigateway.html) ETag (string) --
ApiGatewayManagement LastModified (datetime) --
Api Expiration (string) --
(apigatewaymanagement If the object expiration is configured, the response includes this
api.html) header.
Boto 3 Docs 1.9.249
documentation ( VersionId (string) --
../../index.html) Version ID of the newly created copy.
TABLE OF CONTENTS
Quickstart
(../../guide/quickstart.html) SSECustomerAlgorithm (string) --
A Sample Tutorial If server-side encryption with a customer-provided encryption key was

(../../guide/sqs.html) requested, the response will include this header confirming the
Code Examples

(../../guide/index.html) requested, the response will include this header to provide round trip
ACM (acm.html)
ACMPCA (acm-pca.html) master encryption key that was used for the object.
AlexaForBusiness SSEKMSEncryptionContext (string) --
Amplify (amplify.html) encryption. The value of this header is a base64-encoded UTF-8 string
APIGateway holding JSON with the encryption context key-value pairs.
(apigateway.html) RequestCharged (string) --
Api request.
api.html)
Boto 3 Docs 1.9.249 delete (**kwargs)
documentation ( Removes the null version (if there is one) of an object and inserts a delete
../../index.html)
version, Amazon S3 does not remove any objects.
TABLE OF CONTENTS
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObject)

A Sample Tutorial response = object_summary.delete(

(../../guide/sqs.html) MFA='string',
VersionId='string',
Code Examples
User Guides )

ACM (acm.html) MFA (string) -- The concatenation of the authentication device's serial
device.
AlexaForBusiness VersionId (string) -- VersionId used to reference a specific version of the
(alexaforbusiness.html) object.
Api
object lock should bypass governance-mode restrictions to process this
api.html)
operation.
Boto 3 Docs 1.9.249
../../index.html) dict
Returns
TABLE OF CONTENTS
Response Syntax
Quickstart
Code Examples }

(dict) --
Available Services (index.html) DeleteMarker (boolean) --
ACM (acm.html) Specifies whether the versioned object that was permanently deleted
ACMPCA (acm-pca.html) was (true) or was not (false) a delete marker.
AlexaForBusiness VersionId (string) --

(alexaforbusiness.html) Returns the version ID of the delete marker created as a result of the
Amplify (amplify.html) DELETE operation.

Api
api.html) get (**kwargs)
Retrieves objects from Amazon S3.
Boto 3 Docs 1.9.249
../../index.html)
Request Syntax
TABLE OF CONTENTS
response = object_summary.get(
Quickstart IfMatch='string',
(../../guide/quickstart.html) IfModifiedSince=datetime(2015, 1, 1),
A Sample Tutorial IfNoneMatch='string',
(../../guide/sqs.html) IfUnmodifiedSince=datetime(2015, 1, 1),
Range='string',
Code Examples
User Guides ResponseContentEncoding='string',
(../../guide/index.html) ResponseContentLanguage='string',
ResponseContentType='string',
ResponseExpires=datetime(2015, 1, 1),
ACM (acm.html) VersionId='string',
AlexaForBusiness RequestPayer='requester',
(alexaforbusiness.html) PartNumber=123
APIGateway
(apigateway.html) Parameters
ApiGatewayManagement IfMatch (string) -- Return the object only if its entity tag (ETag) is the same
Api as the one specified, otherwise return a 412 (precondition failed).
(apigatewaymanagement IfModifiedSince (datetime) -- Return the object only if it has been
api.html) modified since the specified time, otherwise return a 304 (not modified).
Boto 3 Docs 1.9.249
documentation ( IfUnmodifiedSince (datetime) -- Return the object only if it has not been
../../index.html) modified since the specified time, otherwise return a 412 (precondition
failed).
TABLE OF CONTENTS Range (string) -- Downloads the specified range bytes of an object. For
Quickstart http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
(../../guide/quickstart.html) (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35).
ResponseCacheControl (string) -- Sets the Cache-Control header of the
A Sample Tutorial response.
(../../guide/sqs.html) ResponseContentDisposition (string) -- Sets the Content-Disposition
Code Examples header of the response
(../../guide/examples.html) ResponseContentEncoding (string) -- Sets the Content-Encoding header
of the response.
User Guides ResponseContentLanguage (string) -- Sets the Content-Language header
(../../guide/index.html) of the response.
ResponseContentType (string) -- Sets the Content-Type header of the
response.
ACM (acm.html) ResponseExpires (datetime) -- Sets the Expires header of the response.
object.
AlexaForBusiness SSECustomerAlgorithm (string) -- Specifies the algorithm to use to when
(alexaforbusiness.html) encrypting the object (e.g., AES256).
Amplify (amplify.html) SSECustomerKey (string) -- Specifies the customer-provided encryption
APIGateway the object and then it is discarded; Amazon does not store the encryption
(apigateway.html) key. The key must be appropriate for use with the algorithm specified in
ApiGatewayManagement the x-amz-server-side-encryption-customer-algorithm header.
Api SSECustomerKeyMD5 (string) --
api.html)
Boto 3 Docs 1.9.249
documentation ( ensure the encryption key was transmitted without error.
../../index.html)

TABLE OF CONTENTS
Quickstart
(../../guide/quickstart.html) RequestPayer (string) -- Confirms that the requester knows that she or
A Sample Tutorial
Code Examples http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
(../../guide/examples.html) (http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
User Guides
GET request for the part specified. Useful for downloading just a part of
Available Services (index.html) an object.

dict
Returns
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
TABLE OF CONTENTS
Quickstart
'ETag': 'string',
User Guides
ACM (acm.html)
'Metadata': {
AlexaForBusiness
},
Api
'TagCount': 123,
Boto 3 Docs 1.9.249
}
TABLE OF CONTENTS

(dict) --
A Sample Tutorial

response.
ACM (acm.html)
AlexaForBusiness

(apigateway.html)
Api
Boto 3 Docs 1.9.249

Quickstart
A Sample Tutorial
ACM (acm.html)
AlexaForBusiness
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249
TABLE OF CONTENTS


(string) --
AlexaForBusiness
(apigateway.html)
api.html)
Boto 3 Docs 1.9.249
documentation (
../../index.html)
request.
Quickstart
A Sample Tutorial

ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api Returns
api.html)
Return type
Boto 3 Docs 1.9.249
list of str
documentation (
../../index.html)
initiate_multipart_upload (**kwargs)
TABLE OF CONTENTS Initiates a multipart upload and returns an upload ID.
Quickstart
(../../guide/quickstart.html) Note: After you initiate multipart upload and upload one or more parts,
you must either complete or abort multipart upload in order to stop
A Sample Tutorial getting charged for storage of the uploaded parts. Only after you either
(../../guide/sqs.html) complete or abort multipart upload, Amazon S3 frees up the parts storage
Code Examples and stops charging you for the parts storage.

Request Syntax
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 multipart_upload = object_summary.initiate_multipart_upload(
TABLE OF CONTENTS
Quickstart
Code Examples GrantWriteACP='string',
(../../guide/examples.html) Metadata={
'string': 'string'
User Guides
},
Available Services (index.html) StorageClass='STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|'ONEZON
ACM (acm.html)
ACMPCA (acm-pca.html) SSECustomerKey='string',
AlexaForBusiness
(alexaforbusiness.html) SSEKMSEncryptionContext='string',
Amplify (amplify.html) Tagging='string',
APIGateway ObjectLockMode='GOVERNANCE'|'COMPLIANCE',
(apigateway.html) ObjectLockRetainUntilDate=datetime(2015, 1, 1),
)
Api
api.html)
Parameters
Boto 3 Docs 1.9.249
documentation ( CacheControl (string) -- Specifies caching behavior along the
../../index.html) request/reply chain.
TABLE OF CONTENTS the object.
Quickstart applied to the object and thus what decoding mechanisms must be
(../../guide/quickstart.html) applied to obtain the media-type referenced by the Content-Type header
field.
A Sample Tutorial
Code Examples the object data.
(../../guide/examples.html) Expires (datetime) -- The date and time at which the object is no longer
cacheable.
User Guides GrantFullControl (string) -- Gives the grantee READ, READ_ACP, and
(../../guide/index.html) WRITE_ACP permissions on the object.
metadata.
ACM (acm.html) GrantReadACP (string) -- Allows grantee to read the object ACL.
ACMPCA (acm-pca.html) GrantWriteACP (string) -- Allows grantee to write the ACL for the
applicable object.
AlexaForBusiness Metadata (dict) --
(alexaforbusiness.html) A map of metadata to store with the object in S3.
(apigateway.html) ServerSideEncryption (string) -- The Server-side encryption algorithm
Api
to 'STANDARD'.
api.html)
Boto 3 Docs 1.9.249
documentation ( SSECustomerAlgorithm (string) -- Specifies the algorithm to use to when
../../index.html) encrypting the object (e.g., AES256).
TABLE OF CONTENTS key for Amazon S3 to use in encrypting data. This value is used to store
Quickstart key. The key must be appropriate for use with the algorithm specified in
(../../guide/quickstart.html) the x-amz-server-side-encryption-customer-algorithm header.
A Sample Tutorial Specifies the 128-bit MD5 digest of the encryption key according to RFC
(../../guide/sqs.html) 1321. Amazon S3 uses this header for a message integrity check to
Code Examples ensure the encryption key was transmitted without error.
User Guides Please note that this parameter is automatically populated if it is not
(../../guide/index.html) provided. Including this parameter is not required

ACM (acm.html)
ACMPCA (acm-pca.html) will fail if not made via SSL or using SigV4. Documentation on configuring
AlexaForBusiness
signature-version
Amplify (amplify.html) (http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify
signature-version)
APIGateway
(apigateway.html)
ApiGatewayManagement encoded UTF-8 string holding JSON with the encryption context key-value
Api pairs.
(apigatewaymanagement RequestPayer (string) -- Confirms that the requester knows that she or
api.html) he will be charged for the request. Bucket owners need not specify this
Boto 3 Docs 1.9.249
documentation ( http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
../../index.html) (http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
TABLE OF CONTENTS as URL Query parameters
ObjectLockMode (string) -- Specifies the object lock mode that you want
Quickstart to apply to the uploaded object.
(../../guide/quickstart.html) ObjectLockRetainUntilDate (datetime) -- Specifies the date and time
when you want the object lock to expire.
A Sample Tutorial ObjectLockLegalHoldStatus (string) -- Specifies whether you want to
(../../guide/sqs.html) apply a Legal Hold to the uploaded object.
(../../guide/examples.html) s3.MultipartUpload
User Guides Returns
(../../guide/index.html) MultipartUpload resource
ACM (acm.html) load (*args, **kwargs)

ACMPCA (acm-pca.html) Calls s3.Client.head_object to update the attributes of the ObjectSummary
resource.
AlexaForBusiness
put (**kwargs)
APIGateway
Api Request Syntax
api.html)
Boto 3 Docs 1.9.249 response = object_summary.put(
TABLE OF CONTENTS
Quickstart
ContentLength=123,
User Guides
Metadata={
Available Services (index.html) 'string': 'string'
},
ACM (acm.html)
ACMPCA (acm-pca.html) StorageClass='STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|'ONEZON
AlexaForBusiness
(alexaforbusiness.html) SSECustomerAlgorithm='string',
Amplify (amplify.html) SSEKMSKeyId='string',
APIGateway SSEKMSEncryptionContext='string',
Tagging='string',
Api
api.html)
Boto 3 Docs 1.9.249
)
documentation (
../../index.html)
Parameters
TABLE OF CONTENTS
User Guides field.
ACM (acm.html)
the object data.
Api metadata.
api.html)
Boto 3 Docs 1.9.249
applicable object.
documentation ( Metadata (dict) --
../../index.html) A map of metadata to store with the object in S3.
(string) --
Quickstart used when storing this object in S3 (e.g., AES256, aws:kms).
(../../guide/quickstart.html) StorageClass (string) -- The type of storage to use for the object. Defaults
A Sample Tutorial to 'STANDARD'.
(../../guide/sqs.html) WebsiteRedirectLocation (string) -- If the bucket is configured as a
Code Examples bucket or to an external URL. Amazon S3 stores the value of this header
(../../guide/examples.html) in the object metadata.
User Guides
Available Services (index.html) key for Amazon S3 to use in encrypting data. This value is used to store
ACM (acm.html)
ACMPCA (acm-pca.html) the x-amz-server-side-encryption-customer-algorithm header.
AlexaForBusiness
Amplify (amplify.html) ensure the encryption key was transmitted without error.
APIGateway
(apigateway.html)
ApiGatewayManagement provided. Including this parameter is not required
Api
api.html)
Boto 3 Docs 1.9.249
documentation ( will fail if not made via SSL or using SigV4. Documentation on configuring
../../index.html) any of the officially supported AWS SDKs and CLI can be found at
TABLE OF CONTENTS signature-version
Quickstart signature-version)
(../../guide/quickstart.html) SSEKMSEncryptionContext (string) -- Specifies the AWS KMS Encryption
A Sample Tutorial encoded UTF-8 string holding JSON with the encryption context key-value
(../../guide/sqs.html) pairs.
Code Examples RequestPayer (string) -- Confirms that the requester knows that she or
(../../guide/examples.html) he will be charged for the request. Bucket owners need not specify this
User Guides from requester pays buckets can be found at
(../../guide/index.html) http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
ACM (acm.html) as URL Query parameters. (For example, "Key1=Value1")
ObjectLockMode (string) -- The object lock mode that you want to apply
to this object.
AlexaForBusiness ObjectLockRetainUntilDate (datetime) -- The date and time when you
(alexaforbusiness.html) want this object's object lock to expire.
Amplify (amplify.html) ObjectLockLegalHoldStatus (string) -- The Legal Hold status that you
APIGateway
dict
Api Returns
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'Expiration': 'string',
TABLE OF CONTENTS
Quickstart
A Sample Tutorial 'RequestCharged': 'requester'
Code Examples
Response Structure
ACM (acm.html) date (expiry-date) and rule ID (rule-id). The value of rule-id is URL
encoded.
AlexaForBusiness
ETag (string) --
(alexaforbusiness.html) Entity tag for the uploaded object.
Amplify (amplify.html) ServerSideEncryption (string) --
APIGateway The Server-side encryption algorithm used when storing this object in
(apigateway.html) S3 (e.g., AES256, aws:kms).
Api
Version of the object.
api.html) SSECustomerAlgorithm (string) --
Boto 3 Docs 1.9.249
documentation ( encryption algorithm used.
../../index.html)
TABLE OF CONTENTS If server-side encryption with a customer-provided encryption key was

Quickstart
(../../guide/quickstart.html) SSEKMSKeyId (string) --
A Sample Tutorial If present, specifies the ID of the AWS Key Management Service (KMS)
(../../guide/sqs.html) master encryption key that was used for the object.
Code Examples SSEKMSEncryptionContext (string) --
User Guides encryption. The value of this header is a base64-encoded UTF-8 string
(../../guide/index.html) holding JSON with the encryption context key-value pairs.
Available Services (index.html) RequestCharged (string) --
ACM (acm.html) If present, indicates that the requester was successfully charged for the
request.
AlexaForBusiness
(alexaforbusiness.html) restore_object (**kwargs)
Restores an archived copy of an object back into Amazon S3
APIGateway
(https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreObject)
(apigateway.html)
Request Syntax
Api
api.html)
Boto 3 Docs 1.9.249 response = object_summary.restore_object(
documentation ( VersionId='string',
../../index.html) RestoreRequest={
'Days': 123,
TABLE OF CONTENTS
},
Quickstart
'Type': 'SELECT',
'Tier': 'Standard'|'Bulk'|'Expedited',
A Sample Tutorial 'Description': 'string',
(../../guide/sqs.html) 'SelectParameters': {
Code Examples 'InputSerialization': {
(../../guide/examples.html) 'CSV': {
User Guides
Available Services (index.html) 'RecordDelimiter': 'string',
'FieldDelimiter': 'string',
ACM (acm.html)
ACMPCA (acm-pca.html) 'AllowQuotedRecordDelimiter': True|False
},
AlexaForBusiness
(alexaforbusiness.html) 'CompressionType': 'NONE'|'GZIP'|'BZIP2',
'JSON': {
Amplify (amplify.html) 'Type': 'DOCUMENT'|'LINES'
APIGateway },
(apigateway.html) 'Parquet': {}
},
Api
api.html) 'Expression': 'string',
'OutputSerialization': {
Boto 3 Docs 1.9.249
'CSV': {
documentation ( 'QuoteFields': 'ALWAYS'|'ASNEEDED',
../../index.html) 'QuoteEscapeCharacter': 'string',
TABLE OF CONTENTS 'FieldDelimiter': 'string',
'QuoteCharacter': 'string'
Quickstart },
(../../guide/quickstart.html) 'JSON': {
A Sample Tutorial
}
}
Code Examples },
(../../guide/examples.html) 'OutputLocation': {
User Guides 'S3': {
(../../guide/index.html) 'BucketName': 'string',
'Prefix': 'string',
Available Services (index.html) 'Encryption': {
ACM (acm.html) 'EncryptionType': 'AES256'|'aws:kms',
'KMSKeyId': 'string',
'KMSContext': 'string'
AlexaForBusiness },
(alexaforbusiness.html) 'CannedACL': 'private'|'public-read'|'public-read-writ
Amplify (amplify.html) 'AccessControlList': [

{
APIGateway 'Grantee': {
(apigateway.html)
ApiGatewayManagement 'EmailAddress': 'string',
Api 'ID': 'string',
(apigatewaymanagement 'Type': 'CanonicalUser'|'AmazonCustomerByE
api.html) 'URI': 'string'
},
Boto 3 Docs 1.9.249
'Permission': 'FULL_CONTROL'|'WRITE'|'WRITE_AC
documentation ( },
'Tagging': {
TABLE OF CONTENTS 'TagSet': [
{
Quickstart 'Key': 'string',
(../../guide/quickstart.html) 'Value': 'string'
},
A Sample Tutorial
]
},
Code Examples 'UserMetadata': [
User Guides 'Name': 'string',
},
ACM (acm.html) 'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'STAND
}
}
AlexaForBusiness },
(alexaforbusiness.html) RequestPayer='requester'
APIGateway
(apigateway.html)
Parameters
Api RestoreRequest (dict) --
api.html)
Boto 3 Docs 1.9.249
OutputLocation.
documentation (
../../index.html)
Glacier related parameters pertaining to this job. Do not use with
restores that specify OutputLocation.
TABLE OF CONTENTS
Tier (string) -- [REQUIRED]
Quickstart
Type of restore request.
A Sample Tutorial
(../../guide/sqs.html) Tier (string) --
Code Examples
(../../guide/examples.html) Description (string) --
User Guides
(../../guide/index.html) SelectParameters (dict) --
Describes the parameters for Select job types.
InputSerialization (dict) -- [REQUIRED]
ACM (acm.html) Describes the serialization format of the object.
ACMPCA (acm-pca.html) CSV (dict) --
AlexaForBusiness Describes the serialization of a CSV-encoded object.
(alexaforbusiness.html) FileHeaderInfo (string) --
Amplify (amplify.html) Describes the first line of input. Valid values: None, Ignore, Use.
APIGateway Comments (string) --

(apigateway.html) The single character used to indicate a row should be ignored
when present at the start of a row.
Api QuoteEscapeCharacter (string) --
(apigatewaymanagement The single character used for escaping the quote character
api.html) inside an already escaped value.
Boto 3 Docs 1.9.249
documentation (
../../index.html)
TABLE OF CONTENTS QuoteCharacter (string) --

value.
Quickstart
(../../guide/quickstart.html) AllowQuotedRecordDelimiter (boolean) --
A Sample Tutorial
FALSE. Setting this value to TRUE may lower performance.
Code Examples
Specifies object's compression format. Valid values: NONE, GZIP,
User Guides BZIP2. Default Value: NONE.
JSON (dict) --
Available Services (index.html) Specifies JSON as object's input serialization format.
ACM (acm.html) Type (string) --

The type of JSON. Valid values: Document, Lines.
Parquet (dict) --
AlexaForBusiness Specifies Parquet as object's input serialization format.
ExpressionType (string) -- [REQUIRED]
Amplify (amplify.html) The type of the provided expression (e.g., SQL).
APIGateway Expression (string) -- [REQUIRED]
(apigateway.html) The expression that is used to query the object.
ApiGatewayManagement OutputSerialization (dict) -- [REQUIRED]
Api Describes how the results of the Select job are serialized.
api.html) CSV (dict) --
Boto 3 Docs 1.9.249
documentation ( QuoteFields (string) --
../../index.html)
TABLE OF CONTENTS Th single character used for escaping the quote character inside
Quickstart RecordDelimiter (string) --
(../../guide/quickstart.html) The value used to separate individual records.
A Sample Tutorial FieldDelimiter (string) --
(../../guide/sqs.html) The value used to separate individual fields in a record.
Code Examples QuoteCharacter (string) --
(../../guide/examples.html) The value used for escaping where the field delimiter is part of
the value.
User Guides
(../../guide/index.html) JSON (dict) --
Specifies JSON as request's output serialization format.
ACM (acm.html) The value used to separate individual records in the output.
ACMPCA (acm-pca.html) OutputLocation (dict) --
AlexaForBusiness Describes the location where the restore job's output is stored.
(alexaforbusiness.html) S3 (dict) --
Amplify (amplify.html) Describes an S3 location that will receive the results of the restore
request.
APIGateway
(apigateway.html) BucketName (string) -- [REQUIRED]
The name of the bucket where the restore results will be placed.
Api Prefix (string) -- [REQUIRED]
(apigatewaymanagement The prefix that is prepended to the restore results for this request.
api.html) Encryption (dict) --
Boto 3 Docs 1.9.249
documentation ( results in Amazon S3 (e.g., AES256, aws:kms).
../../index.html)
TABLE OF CONTENTS the AWS KMS key ID to use for encryption of job results.
Quickstart
to specify the encryption context for the restore results.
A Sample Tutorial
The canned ACL to apply to the restore results.
Code Examples
A list of grants that control access to the staged results.
User Guides
(dict) --
Grantee (dict) --
Available Services (index.html) DisplayName (string) --
ACM (acm.html)
ACMPCA (acm-pca.html) Email address of the grantee.
AlexaForBusiness ID (string) --
(alexaforbusiness.html) The canonical user ID of the grantee.
Amplify (amplify.html) Type (string) -- [REQUIRED]
APIGateway Type of grantee
(apigateway.html) URI (string) --
ApiGatewayManagement URI of the grantee group.
Api Permission (string) --
(apigatewaymanagement Specifies the permission given to the grantee.
api.html)
Tagging (dict) --
Boto 3 Docs 1.9.249
documentation (
../../index.html)
(dict) --

Quickstart
Value of the tag.
A Sample Tutorial
(dict) --
Code Examples
Name (string) --
User Guides
Value (string) --
Available Services (index.html) The class of storage used to store the restore results.
ACM (acm.html) RequestPayer (string) -- Confirms that the requester knows that she or
ACMPCA (acm-pca.html) parameter in their requests. Documentation on downloading objects
AlexaForBusiness from requester pays buckets can be found at
(alexaforbusiness.html) http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
Return type
APIGateway
dict
(apigateway.html)
Returns
Api Response Syntax
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'RequestCharged': 'requester',
../../index.html) 'RestoreOutputPath': 'string'
}
TABLE OF CONTENTS
Response Structure
Quickstart
(dict) --
A Sample Tutorial
request.
Code Examples
(../../guide/examples.html) RestoreOutputPath (string) --
User Guides Indicates the path in the provided S3 output location where Select
(../../guide/index.html) results will be restored to.

Sub-resources
ACM (acm.html)
ACMPCA (acm-pca.html) resource's identifiers get passed along to the child. For more information about
AlexaForBusiness sub-resources refer to the Resources Introduction Guide
(alexaforbusiness.html) (../../guide/resources.html#subresources-intro).
Amplify (amplify.html) Acl ()

Creates a ObjectAcl resource.:
APIGateway
(apigateway.html)
ApiGatewayManagement object_acl = object_summary.Acl()

Api
api.html)
S3.ObjectAcl
Boto 3 Docs 1.9.249
../../index.html) A ObjectAcl resource
TABLE OF CONTENTS
Bucket ()
Quickstart
bucket = object_summary.Bucket()
A Sample Tutorial

(../../guide/examples.html) S3.Bucket
User Guides Returns

(../../guide/index.html) A Bucket resource
ACM (acm.html) MultipartUpload (id)

Creates a MultipartUpload resource.:
AlexaForBusiness
multipart_upload = object_summary.MultipartUpload('id')
Parameters
APIGateway
id (string) -- The MultipartUpload's id identifier. This must be set.
(apigateway.html)
Return type
S3.MultipartUpload
Api
api.html) A MultipartUpload resource
Boto 3 Docs 1.9.249
documentation ( Object ()
../../index.html) Creates a Object resource.:
TABLE OF CONTENTS
object = object_summary.Object()
Quickstart
(../../guide/quickstart.html) Return type
S3.Object
A Sample Tutorial
Code Examples A Object resource
User Guides Version (id)

Creates a ObjectVersion resource.:
ACM (acm.html) object_version = object_summary.Version('id')
Parameters
AlexaForBusiness
(alexaforbusiness.html) id (string) -- The Version's id identifier. This must be set.

S3.ObjectVersion
APIGateway
Api
Waiters
api.html)
Boto 3 Docs 1.9.249
documentation ( (../../guide/resources.html#waiters-intro).
../../index.html)
wait_until_exists (**kwargs)
Waits until this ObjectSummary is exists. This method calls
TABLE OF CONTENTS
S3.Waiter.object_exists.wait() which polls. S3.Client.head_object() every
5 seconds until a successful state is reached. An error is returned after 20 failed
Quickstart
checks.
A Sample Tutorial
Request Syntax
Code Examples
object_summary.wait_until_exists(
User Guides
IfMatch='string',
Available Services (index.html) IfNoneMatch='string',
ACM (acm.html)
Range='string',
ACMPCA (acm-pca.html) VersionId='string',
AlexaForBusiness SSECustomerAlgorithm='string',
(alexaforbusiness.html) SSECustomerKey='string',
PartNumber=123
APIGateway )
(apigateway.html)
Api IfMatch (string) -- Return the object only if its entity tag (ETag) is the same
(apigatewaymanagement as the one specified, otherwise return a 412 (precondition failed).
api.html)
Boto 3 Docs 1.9.249
documentation ( IfNoneMatch (string) -- Return the object only if its entity tag (ETag) is
../../index.html) different from the one specified, otherwise return a 304 (not modified).
TABLE OF CONTENTS modified since the specified time, otherwise return a 412 (precondition
failed).
Quickstart Range (string) -- Downloads the specified range bytes of an object. For
(../../guide/quickstart.html) more information about the HTTP Range header, go to
A Sample Tutorial (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35).
(../../guide/sqs.html) VersionId (string) -- VersionId used to reference a specific version of the
Code Examples object.
(../../guide/examples.html) SSECustomerAlgorithm (string) -- Specifies the algorithm to use to when
User Guides SSECustomerKey (string) -- Specifies the customer-provided encryption
(../../guide/index.html) key for Amazon S3 to use in encrypting data. This value is used to store
ACM (acm.html) the x-amz-server-side-encryption-customer-algorithm header.
AlexaForBusiness 1321. Amazon S3 uses this header for a message integrity check to
(alexaforbusiness.html) ensure the encryption key was transmitted without error.
APIGateway Please note that this parameter is automatically populated if it is not

(apigateway.html) provided. Including this parameter is not required
Boto 3 Docs 1.9.249
../../index.html) PartNumber (integer) -- Part number of the object being read. This is a
TABLE OF CONTENTS HEAD request for the part specified. Useful querying about the size of the
Quickstart Returns
(../../guide/quickstart.html) None
A Sample Tutorial
wait_until_not_exists (**kwargs)
Code Examples
Waits until this ObjectSummary is not exists. This method calls
S3.Waiter.object_not_exists.wait() which polls. S3.Client.head_object()
User Guides every 5 seconds until a successful state is reached. An error is returned after 20
(../../guide/index.html) failed checks.

ACM (acm.html)
Request Syntax
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 object_summary.wait_until_not_exists(
TABLE OF CONTENTS
Range='string',
VersionId='string',
Quickstart
A Sample Tutorial RequestPayer='requester',
(../../guide/sqs.html) PartNumber=123
Code Examples )

(../../guide/index.html) IfMatch (string) -- Return the object only if its entity tag (ETag) is the same
ACM (acm.html) modified since the specified time, otherwise return a 304 (not modified).
AlexaForBusiness IfUnmodifiedSince (datetime) -- Return the object only if it has not been
(alexaforbusiness.html) modified since the specified time, otherwise return a 412 (precondition
failed).
APIGateway more information about the HTTP Range header, go to
(apigateway.html) http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
Api
object.
api.html)
Boto 3 Docs 1.9.249
documentation ( SSECustomerKey (string) -- Specifies the customer-provided encryption
../../index.html) key for Amazon S3 to use in encrypting data. This value is used to store
TABLE OF CONTENTS key. The key must be appropriate for use with the algorithm specified in
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
Amplify (amplify.html) HEAD request for the part specified. Useful querying about the size of the
APIGateway
Api
api.html)
Boto 3 Docs 1.9.249
documentation (
ObjectVersion
../../index.html)
class S3. ObjectVersion (bucket_name, object_key, id)
A resource representing an Amazon Simple Storage Service (S3) ObjectVersion:
TABLE OF CONTENTS

A Sample Tutorial
object_version = s3.ObjectVersion('bucket_name','object_key','id')
Code Examples
bucket_name (string) -- The ObjectVersion's bucket_name identifier. This
(../../guide/index.html) object_key (string) -- The ObjectVersion's object_key identifier. This must be
set.
id (string) -- The ObjectVersion's id identifier. This must be set.
ACM (acm.html)
bucket_name
AlexaForBusiness
object_key
id
APIGateway
(apigateway.html) e_tag
is_latest
ApiGatewayManagement key
Api
last_modified
owner
api.html)
size
Boto 3 Docs 1.9.249
storage_class
documentation ( version_id
../../index.html)
TABLE OF CONTENTS delete()

get()
Quickstart get_available_subresources()
(../../guide/quickstart.html) head()

Object()
Code Examples
Identifiers

(string) The ObjectVersion's bucket_name identifier. This must be set.
ACM (acm.html)
ACMPCA (acm-pca.html) object_key

(string) The ObjectVersion's object_key identifier. This must be set.
AlexaForBusiness
id
Amplify (amplify.html) (string) The ObjectVersion's id identifier. This must be set.
APIGateway
(apigateway.html)
Attributes
ApiGatewayManagement the first time one is accessed via the load() method. For more information about
Api
api.html)
e_tag
Boto 3 Docs 1.9.249
(string) --
documentation (
../../index.html) is_latest
(boolean) --
TABLE OF CONTENTS
Specifies whether the object is (true) or is not (false) the latest version of
an object.
Quickstart
(../../guide/quickstart.html) key
A Sample Tutorial (string) --
The object key.
Code Examples
(../../guide/examples.html) last_modified
(datetime) --
User Guides
(../../guide/index.html) Date and time the object was last modified.
Available Services (index.html) owner

ID (string) --
AlexaForBusiness
(alexaforbusiness.html) size
Amplify (amplify.html) (integer) --
APIGateway Size in bytes of the object.

(apigateway.html)
storage_class
Api
(apigatewaymanagement The class of storage used to store the object.
api.html)
version_id
Boto 3 Docs 1.9.249
(string) --
documentation (
../../index.html) Version ID of an object.
Actions
TABLE OF CONTENTS
Quickstart actions refer to the Resources Introduction Guide
(../../guide/quickstart.html) (../../guide/resources.html#actions-intro).
A Sample Tutorial
delete (**kwargs)
Removes the null version (if there is one) of an object and inserts a delete
Code Examples marker, which becomes the latest version of the object. If there isn't a null
(../../guide/examples.html) version, Amazon S3 does not remove any objects.
(../../guide/index.html) (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObject)
ACM (acm.html)
response = object_version.delete(
MFA='string',
(alexaforbusiness.html) BypassGovernanceRetention=True|False
APIGateway
Api
device.
api.html)
Boto 3 Docs 1.9.249
Quickstart object lock should bypass governance-mode restrictions to process this
(../../guide/quickstart.html) operation.


(../../guide/examples.html) Response Syntax
User Guides
(../../guide/index.html) {
AlexaForBusiness
APIGateway DeleteMarker (boolean) --

(apigateway.html)
Specifies whether the versioned object that was permanently deleted
ApiGatewayManagement was (true) or was not (false) a delete marker.
Api
api.html)
Returns the version ID of the delete marker created as a result of the
Boto 3 Docs 1.9.249
DELETE operation.
documentation (
../../index.html)
TABLE OF CONTENTS request.
Quickstart
get (**kwargs)
Retrieves objects from Amazon S3.
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 response = object_version.get(
TABLE OF CONTENTS
Range='string',
Quickstart
ResponseContentEncoding='string',
A Sample Tutorial ResponseContentLanguage='string',
(../../guide/sqs.html) ResponseContentType='string',
Code Examples ResponseExpires=datetime(2015, 1, 1),
(../../guide/examples.html) SSECustomerAlgorithm='string',
User Guides
PartNumber=123
ACM (acm.html)
Parameters
AlexaForBusiness as the one specified, otherwise return a 412 (precondition failed).
(alexaforbusiness.html) IfModifiedSince (datetime) -- Return the object only if it has been
Amplify (amplify.html) modified since the specified time, otherwise return a 304 (not modified).
APIGateway different from the one specified, otherwise return a 304 (not modified).
(apigateway.html) IfUnmodifiedSince (datetime) -- Return the object only if it has not been
ApiGatewayManagement modified since the specified time, otherwise return a 412 (precondition
Api failed).
(apigatewaymanagement Range (string) -- Downloads the specified range bytes of an object. For
api.html) more information about the HTTP Range header, go to
Boto 3 Docs 1.9.249
documentation ( ResponseCacheControl (string) -- Sets the Cache-Control header of the
../../index.html) response.
ResponseContentDisposition (string) -- Sets the Content-Disposition
TABLE OF CONTENTS header of the response
ResponseContentEncoding (string) -- Sets the Content-Encoding header
Quickstart of the response.
(../../guide/quickstart.html) ResponseContentLanguage (string) -- Sets the Content-Language header
of the response.
A Sample Tutorial ResponseContentType (string) -- Sets the Content-Type header of the
Code Examples ResponseExpires (datetime) -- Sets the Expires header of the response.
(../../guide/examples.html) SSECustomerAlgorithm (string) -- Specifies the algorithm to use to when
User Guides SSECustomerKey (string) -- Specifies the customer-provided encryption
(../../guide/index.html) key for Amazon S3 to use in encrypting data. This value is used to store
ACM (acm.html) the x-amz-server-side-encryption-customer-algorithm header.
AlexaForBusiness 1321. Amazon S3 uses this header for a message integrity check to
(alexaforbusiness.html) ensure the encryption key was transmitted without error.
APIGateway Please note that this parameter is automatically populated if it is not

(apigateway.html) provided. Including this parameter is not required
Boto 3 Docs 1.9.249
../../index.html) PartNumber (integer) -- Part number of the object being read. This is a
TABLE OF CONTENTS GET request for the part specified. Useful for downloading just a part of
an object.
Response Syntax
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
TABLE OF CONTENTS
Quickstart
'ETag': 'string',
User Guides
ACM (acm.html)
'Metadata': {
AlexaForBusiness
},
Api
'TagCount': 123,
Boto 3 Docs 1.9.249
}
TABLE OF CONTENTS

(dict) --
A Sample Tutorial

response.
ACM (acm.html)
AlexaForBusiness

(apigateway.html)
Api
Boto 3 Docs 1.9.249

Quickstart
A Sample Tutorial
ACM (acm.html)
AlexaForBusiness
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249
TABLE OF CONTENTS


(string) --
AlexaForBusiness
(apigateway.html)
api.html)
Boto 3 Docs 1.9.249
documentation (
../../index.html)
request.
Quickstart
A Sample Tutorial

ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api Returns
api.html)
Return type
Boto 3 Docs 1.9.249
list of str
documentation (
../../index.html)
head (**kwargs)
TABLE OF CONTENTS The HEAD operation retrieves metadata from an object without returning the
object itself. This operation is useful if you're only interested in an object's
Quickstart metadata. To use HEAD, you must have READ access to the object.
A Sample Tutorial (https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadObject)
Request Syntax
Code Examples
response = object_version.head(
User Guides IfMatch='string',
(../../guide/index.html) IfModifiedSince=datetime(2015, 1, 1),
ACM (acm.html) Range='string',
(alexaforbusiness.html) PartNumber=123
APIGateway
ApiGatewayManagement IfMatch (string) -- Return the object only if its entity tag (ETag) is the same
Api as the one specified, otherwise return a 412 (precondition failed).
(apigatewaymanagement IfModifiedSince (datetime) -- Return the object only if it has been
api.html) modified since the specified time, otherwise return a 304 (not modified).
Boto 3 Docs 1.9.249
documentation ( IfUnmodifiedSince (datetime) -- Return the object only if it has not been
../../index.html) modified since the specified time, otherwise return a 412 (precondition
failed).
TABLE OF CONTENTS Range (string) -- Downloads the specified range bytes of an object. For
Quickstart http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
(../../guide/quickstart.html) (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35).
User Guides the x-amz-server-side-encryption-customer-algorithm header.
(../../guide/index.html) SSECustomerKeyMD5 (string) --
ACM (acm.html) ensure the encryption key was transmitted without error.
AlexaForBusiness Please note that this parameter is automatically populated if it is not

(alexaforbusiness.html) provided. Including this parameter is not required
APIGateway
(apigateway.html)
ApiGatewayManagement from requester pays buckets can be found at
Api http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
(apigatewaymanagement (http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuc
api.html)
Boto 3 Docs 1.9.249
Return type
TABLE OF CONTENTS
dict
Quickstart Returns
(../../guide/quickstart.html) Response Syntax
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
Boto 3 Docs 1.9.249 {
documentation ( 'DeleteMarker': True|False,
../../index.html) 'AcceptRanges': 'string',
TABLE OF CONTENTS
Quickstart
'ETag': 'string',
'MissingMeta': 123,
(../../guide/sqs.html) 'CacheControl': 'string',
Code Examples 'ContentDisposition': 'string',
(../../guide/examples.html) 'ContentEncoding': 'string',
User Guides
'ContentType': 'string',
Available Services (index.html) 'WebsiteRedirectLocation': 'string',
ACM (acm.html)
'Metadata': {
ACMPCA (acm-pca.html) 'string': 'string'
},
AlexaForBusiness
(alexaforbusiness.html) 'SSECustomerAlgorithm': 'string',
Amplify (amplify.html) 'SSEKMSKeyId': 'string',
APIGateway 'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|
(apigateway.html) 'RequestCharged': 'requester',
'PartsCount': 123,
Api
api.html) 'ObjectLockRetainUntilDate': datetime(2015, 1, 1),
'ObjectLockLegalHoldStatus': 'ON'|'OFF'
Boto 3 Docs 1.9.249
}
documentation (
../../index.html)
Response Structure
TABLE OF CONTENTS
(dict) --
Quickstart DeleteMarker (boolean) --
A Sample Tutorial Delete Marker. If false, this response header does not appear in the
Code Examples AcceptRanges (string) --
User Guides If the object expiration is configured (see PUT Bucket lifecycle), the
(../../guide/index.html) response includes this header. It includes the expiry-date and rule-id
the rule-id is URL encoded.
ACM (acm.html)
Restore (string) --
AlexaForBusiness time of the restored object copy.
Last modified date of the object
APIGateway
(apigateway.html)
Api ETag (string) --
api.html)
Boto 3 Docs 1.9.249
documentation (
../../index.html)
This is set to the number of metadata entries not returned in x-amz-
TABLE OF CONTENTS meta headers. This can happen if you create metadata using an API like
Quickstart
legal HTTP headers.
A Sample Tutorial
(../../guide/sqs.html) Version of the object.
Code Examples CacheControl (string) --
User Guides ContentDisposition (string) --
ACM (acm.html)
ACMPCA (acm-pca.html) thus what decoding mechanisms must be applied to obtain the media-
AlexaForBusiness type referenced by the Content-Type header field.
(alexaforbusiness.html) ContentLanguage (string) --
Amplify (amplify.html) The language the content is in.
APIGateway ContentType (string) --
(apigateway.html)
A standard MIME type describing the format of the object data.
Api
(apigatewaymanagement The date and time at which the object is no longer cacheable.
api.html)
WebsiteRedirectLocation (string) --
Boto 3 Docs 1.9.249
documentation ( If the bucket is configured as a website, redirects requests for this
object to another object in the same bucket or to an external URL.
../../index.html)
Amazon S3 stores the value of this header in the object metadata.
TABLE OF CONTENTS ServerSideEncryption (string) --

Quickstart S3 (e.g., AES256, aws:kms).
Metadata (dict) --
A Sample Tutorial
(string) --
Code Examples
(string) --
Available Services (index.html) encryption algorithm used.
ACM (acm.html) SSECustomerKeyMD5 (string) --

(apigateway.html)
Api RequestCharged (string) --
api.html) request.
Boto 3 Docs 1.9.249
documentation ( PartsCount (integer) --
../../index.html) The count of parts this object has.
ObjectLockMode (string) --
TABLE OF CONTENTS
Quickstart ObjectLockRetainUntilDate (datetime) --

The date and time when this object's object lock expires.
A Sample Tutorial
The Legal Hold status for the specified object.
Code Examples
Sub-resources
User Guides
Available Services (index.html) sub-resources refer to the Resources Introduction Guide
ACM (acm.html)
ACMPCA (acm-pca.html) Object ()

AlexaForBusiness
object = object_version.Object()
APIGateway
S3.Object
Api Returns
(apigatewaymanagement A Object resource
api.html)
Boto 3 Docs 1.9.249
documentation (
Examples
../../index.html)
TABLE OF CONTENTS List objects in an Amazon S3 bucket

List top-level common prefixes in Amazon S3 bucket
Quickstart Restore Glacier objects in an Amazon S3 bucket
(../../guide/quickstart.html) Uploading/downloading files using SSE KMS
Uploading/downloading files using SSE Customer Keys
A Sample Tutorial
Code Examples
List objects in an Amazon S3 bucket
User Guides
(../../guide/index.html) The following example shows how to use an Amazon S3 bucket resource to list the
objects in the bucket.
ACM (acm.html)
import boto3
AlexaForBusiness s3 = boto3.resource('s3')
(alexaforbusiness.html) bucket = s3.Bucket('my-bucket')
for obj in bucket.objects.all():
print(obj.key)
APIGateway
(apigateway.html)
ApiGatewayManagement List top-level common prefixes in Amazon S3

Api
bucket
api.html)
This example shows how to list all of the top-level common prefixes in an Amazon S3
Boto 3 Docs 1.9.249
bucket:
documentation (
../../index.html)
import boto3
TABLE OF CONTENTS
client = boto3.client('s3')
paginator = client.get_paginator('list_objects')
Quickstart
result = paginator.paginate(Bucket='my-bucket', Delimiter='/')
for prefix in result.search('CommonPrefixes'):
A Sample Tutorial print(prefix.get('Prefix'))
Code Examples
(../../guide/examples.html) Restore Glacier objects in an Amazon S3 bucket
User Guides
(../../guide/index.html) The following example shows how to initiate restoration of glacier objects in an Amazon
S3 bucket, determine if a restoration is on-going, and determine if a restoration is
Available Services (index.html) finished.
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
documentation (
bucket = s3.Bucket('glacier-bucket')
for obj_sum in bucket.objects.all():
TABLE OF CONTENTS
obj = s3.Object(obj_sum.bucket_name, obj_sum.key)
if obj.storage_class == 'GLACIER':
Quickstart
# Try to restore the object if the storage class is glacier and
# the object does not have a completed or ongoing restoration
A Sample Tutorial # request.
(../../guide/sqs.html) if obj.restore is None:
Code Examples print('Submitting restoration request: %s' % obj.key)
(../../guide/examples.html) obj.restore_object(RestoreRequest={'Days': 1})
# Print out objects whose restoration is on-going
User Guides
elif 'ongoing-request="true"' in obj.restore:
print('Restoration in-progress: %s' % obj.key)
Available Services (index.html) # Print out objects whose restoration is complete
elif 'ongoing-request="false"' in obj.restore:
ACM (acm.html)
print('Restoration complete: %s' % obj.key)
AlexaForBusiness
(alexaforbusiness.html) Uploading/downloading files using SSE KMS
This example shows how to use SSE-KMS to upload objects using server side encryption
APIGateway
with a key managed by KMS.
(apigateway.html)
We can either use the default KMS master key, or create a custom key in AWS and use it
to encrypt the object by passing in its key id.
Api
(apigatewaymanagement With KMS, nothing else needs to be provided for getting the object; S3 already knows
api.html) how to decrypt the object.
documentation ( import os
../../index.html)
BUCKET = 'your-bucket-name'
TABLE OF CONTENTS
keyid = '<the key id>'
Quickstart
print("Uploading S3 object with SSE-KMS")
s3.put_object(Bucket=BUCKET,
A Sample Tutorial Key='encrypt-key',
(../../guide/sqs.html) Body=b'foobar',
Code Examples ServerSideEncryption='aws:kms',
(../../guide/examples.html) # Optional: SSEKMSKeyId
SSEKMSKeyId=keyid)
User Guides
print("Done")
Available Services (index.html) # Getting the object:

print("Getting S3 object...")
ACM (acm.html)
response = s3.get_object(Bucket=BUCKET,
ACMPCA (acm-pca.html) Key='encrypt-key')
print("Done, response body:")
AlexaForBusiness
(alexaforbusiness.html) print(response['Body'].read())
APIGateway
Uploading/downloading files using SSE Customer
(apigateway.html)
Keys
Api This example shows how to use SSE-C to upload objects using server side encryption
with a customer provided key.
api.html)
First, we'll need a 32 byte key. For this example, we'll randomly generate a key but you
Boto 3 Docs 1.9.249
can use any 32 byte key you want. Remember, you must the same key to download the
documentation (
object. If you lose the encryption key, you lose the object.
../../index.html)
Also note how we don't have to provide the SSECustomerKeyMD5. Boto3 will
TABLE OF CONTENTS
automatically compute this value for us.
Quickstart
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)
documentation ( import os
../../index.html)
BUCKET = 'your-bucket-name'
KEY = os.urandom(32)
TABLE OF CONTENTS
Quickstart
print("Uploading S3 object with SSE-C")
s3.put_object(Bucket=BUCKET,
A Sample Tutorial Key='encrypt-key',
(../../guide/sqs.html) Body=b'foobar',
Code Examples SSECustomerKey=KEY,
(../../guide/examples.html) SSECustomerAlgorithm='AES256')
print("Done")
User Guides
# Getting the object:
Available Services (index.html) print("Getting S3 object...")
# Note how we're using the same ``KEY`` we
ACM (acm.html)
# created earlier.
ACMPCA (acm-pca.html) response = s3.get_object(Bucket=BUCKET,
Key='encrypt-key',
AlexaForBusiness
(alexaforbusiness.html) SSECustomerKey=KEY,
SSECustomerAlgorithm='AES256')
Amplify (amplify.html) print("Done, response body:")
APIGateway print(response['Body'].read())
(apigateway.html)
Api
Route53Resolver (route53resolver.html) S3Control (s3control.html)
api.html)
Boto 3 Docs 1.9.249
© Copyright 2019, Amazon Web Services, Inc. Created using Sphinx (http://sphinx.pocoo.org/).
documentation (
../../index.html)
TABLE OF CONTENTS
Quickstart
A Sample Tutorial
Code Examples
User Guides
ACM (acm.html)
AlexaForBusiness
APIGateway
(apigateway.html)
Api
api.html)

S3 - Boto 3 Docs 1.9.249 Documentation PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

S3 - Boto 3 Docs 1.9.249 Documentation PDF

Uploaded by

Copyright:

Available Formats

Boto 3 Docs 1.9.

Available Services (index.html)

APIGateway See also: AWS API Documentation

Available Services (index.html) UploadId (string) --

Quickstart Response Structure

../../index.html) Key (string) --

Code Examples ServerSideEncryption (string) --

ApiGatewayManagement copy (CopySource, Bucket, Key, ExtraArgs=None, Callback=None,

TABLE OF CONTENTS import boto3

Available Services (index.html)

TABLE OF CONTENTS Returns

AlexaForBusiness 'SSEKMSEncryptionContext': 'string',

TABLE OF CONTENTS CopySourceVersionId (string) --

User Guides If server-side encryption with a customer-provided encryption key was

documentation ( Initiates a multipart upload and returns an upload ID.

Available Services (index.html)

Available Services (index.html)

Available Services (index.html) (dict) --

ACM (acm.html) AbortDate (datetime) --

../../index.html) ServerSideEncryption (string) --

The Server-side encryption algorithm used when storing this object in

APIGateway RequestCharged (string) --

TABLE OF CONTENTS Request Syntax

Quickstart response = client.delete_bucket(

Code Examples Parameters

User Guides Returns

Available Services (index.html)

ACM (acm.html) delete_bucket_analytics_configuration (**kwargs)

ACMPCA (acm-pca.html) Parameters

AlexaForBusiness The ID used to identify the inventory configuration.

Available Services (index.html) delete_bucket_metrics_configuration (**kwargs)

TABLE OF CONTENTS Id (string) --

ACMPCA (acm-pca.html) response = client.delete_bucket_policy(

ACMPCA (acm-pca.html) The bucket name.

ACMPCA (acm-pca.html) delete_bucket_website (**kwargs)

TABLE OF CONTENTS Parameters

Code Examples delete_object (**kwargs)

AlexaForBusiness response = client.delete_object(

ACMPCA (acm-pca.html) Returns

AlexaForBusiness Response Syntax

Returns the version ID of the delete marker created as a result of the

User Guides delete_object_tagging (**kwargs)

Available Services (index.html) See also: AWS API Documentation

User Guides Response Structure

AlexaForBusiness delete_objects (**kwargs)

Available Services (index.html)

AlexaForBusiness Response Structure

Amplify (amplify.html) Parameters

ApiGatewayManagement The Amazon S3 bucket whose PublicAccessBlock configuration you want

Available Services (index.html) Parameters

Available Services (index.html) Parameters

Code Examples Returns

A Sample Tutorial get_bucket_accelerate_configuration (**kwargs)

Available Services (index.html)

ApiGatewayManagement Return type

Quickstart Response Structure

ACM (acm.html) Request Syntax

Code Examples 'EmailAddress': 'string',

Available Services (index.html) get_bucket_analytics_configuration (**kwargs)

Available Services (index.html)

ACMPCA (acm-pca.html) Prefix (string) --

AlexaForBusiness The prefix to use when evaluating an analytics filter.

TABLE OF CONTENTS Prefix (string) --