Feb 21, Feb 14, Feb 13, Feb 10, Feb 7, Feb 6, Jan 24, Jan 23, Jan 20, Jan 17, Jan 10, Jan 9, Jan 8, Jan 2, Dec 20, Dec 19, Dec 13, Dec 12, Dec 6, Dec 5, Nov 26, Nov 25, Nov 21, Nov 14, Nov 7, Oct 31, Oct 24, Oct 17, Oct 10, Oct 3, Sep 26, Sep 20, Sep 19, Sep 12, Sep 6, Sep 5, Aug 29, Aug 22, Aug 21, Aug 15, Aug 8, Jul 25, Jul 18, Jul 11, Jul 10, Jul 3, Jun 27, Jun 20, Jun 13, Jun 6, May 30, May 29, May 23, May 16, May 2, Apr 25, Apr 18, Apr 4, Mar 21, Mar 14, Mar 7, Feb 20, Jan 25, Jan 18, Jan 16, Jan 3, Nov 30, Nov 29, Nov 28, Nov 27, Aug 1, Jul 5, May 31, Apr 10, Mar 28, Download the file for your platform.
If you're not sure which to choose, learn more about installing packages. Warning Some features may not work without JavaScript. Please try enabling it if you encounter problems. Search PyPI Search. Latest version Released: Nov 24, Navigation Project description Release history Download files.
Project links Homepage Source Documentation. Maintainers aws. Boto3 is maintained and published by Amazon Web Services. Running Tests You can run tests in all supported Python versions using tox. Getting Help We use GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.
Please use these community resources for getting help: Ask a question on Stack Overflow and tag it with boto3 Come join the AWS Python community chat on gitter Open a support ticket with AWS Support If it turns out that you may have found a bug, please open an issue. Contributing We value feedback and contributions from our community. Project details Project links Homepage Source Documentation.
Download files Download the file for your platform. Files for boto3, version 1. Close Hashes for boto File type Wheel. Python version py3. Upload date Nov 24, Hashes View. File type Source. Container for redirect information. You can redirect requests to another host, to another page, or with another protocol.
In the event of an error, you can specify a different error code to return. The object key prefix to use in the redirect request. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided. The specific object key to use in the redirect request. For example, redirect request to error. Can be present only if ReplaceKeyPrefixWith is not provided. Retrieves objects from Amazon S3.
If you grant READ access to the anonymous user, you can return the object without using an authorization header. An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample. To get an object from such a logical hierarchy, specify the full key name for the object in the GET operation.
To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent.
Otherwise, this action returns an InvalidObjectStateError error. For information about restoring archived objects, see Restoring Archived Objects. If you encrypt an object by using server-side encryption with customer-provided encryption keys SSE-C when you store the object in Amazon S3, then when you GET the object, you must use the following headers:. Assuming you have the relevant permission to read object tags, the response also returns the x-amz-tagging-count header that provides the count of number of tags associated with the object.
You can use GetObjectTagging to retrieve the tag set associated with an object. You need the relevant read object or version permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.
By default, the GET action returns the current version of an object. To return a different version, use the versionId subresource. For more information about versioning, see PutBucketVersioning.
There are times when you want to override certain response header values in a GET response. You can override values for a set of response headers using the following query parameters.
These response header values are sent only on a successful request, that is, when status code OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object.
To override these header values in the GET response, you use the following request parameters. You must sign the request, either using an Authorization header or a presigned URL, when using these parameters.
They cannot be used with an unsigned anonymous request. If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true , and; If-Unmodified-Since condition evaluates to false ; then, S3 returns OK and the data requested. For more information about conditional requests, see RFC The following operations are related to GetObject :. Downloads the specified range bytes of an object.
Amazon S3 doesn't support retrieving multiple ranges of data per GET request. Body StreamingBody Specifies whether the object retrieved was true or was not false a Delete Marker. If false, this response header does not appear in the response. If the object expiration is configured see PUT Bucket lifecycle , the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL encoded.
Provides information about object restoration action and expiration time of the restored object copy. An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL. This is set to the number of metadata entries not returned in x-amz-meta headers.
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 field. 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.
Amazon S3 stores the value of this header in the object metadata. Provides storage class information of the object.
Amazon S3 returns this header for all objects except for S3 Standard storage class objects. Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule. 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. The following example retrieves an object for an S3 bucket.
The request specifies the range header to retrieve a specific byte range. Returns the access control list ACL of an object. To return ACL information about a different version, use the versionId subresource. The following operations are related to GetObjectAcl :. Gets an object's current Legal Hold status.
For more information, see Locking Objects. Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket.
Indicates whether this bucket has an Object Lock configuration enabled. Specifies the Object Lock rule for the specified object. Enable the this rule when you apply ObjectLockConfiguration to a bucket. Bucket settings require both a mode and a period. The period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time. The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket.
The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. Must be used with either Days or Years. The number of days that you want to specify for the default retention period.
Must be used with Mode. The number of years that you want to specify for the default retention period. Retrieves an object's retention settings. Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.
To use this operation, you must have permission to perform the s3:GetObjectTagging action. By default, the GET action returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket.
To retrieve tags of any other version, use the versionId query parameter. You also need permission for the s3:GetObjectVersionTagging action. For information about the Amazon S3 object tagging feature, see Object Tagging. The following action is related to GetObjectTagging :. Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files.
You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using server-side encryption with a customer-provided encryption key.
The following action is related to GetObjectTorrent :. When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket or the bucket that contains the object and the bucket owner's account. If the PublicAccessBlock settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public". The following operations are related to GetPublicAccessBlock :. Specifies whether Amazon S3 should block public access control lists ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes the following behavior:.
Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set. Specifies whether Amazon S3 should block public bucket policies for this bucket. Specifies whether Amazon S3 should restrict public bucket policies for this bucket.
Setting this element to TRUE restricts access to this bucket to only Amazon Web Service principals and authorized users within this account if the bucket has a public policy. Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.
This action is useful to determine if a bucket exists and you have permission to access it. The action returns a OK if the bucket exists and you have permission to access it. If the bucket does not exist or you do not have permission to access it, the HEAD request returns a generic Not Found or Forbidden code.
A message body is not included, so you cannot determine the exception beyond these error codes. To use this operation, you must have permissions to perform the s3:ListBucket action.
To use this API against an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. For more information see, Using access points. The HEAD action retrieves metadata from an object without returning the object itself.
This action is useful if you're only interested in an object's metadata. The response is identical to the GET response except that there is no response body. It is not possible to retrieve the exact exception beyond these error codes. If you encrypt an object by using server-side encryption with customer-provided encryption keys SSE-C when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:.
Request headers are limited to 8 KB in size. For more information, see Common Request Headers. Then Amazon S3 returns OK and the data requested. Then Amazon S3 returns the Not Modified response code. The following action is related to HeadObject :. If the object is an archived object an object whose storage class is GLACIER , the response includes this header if either the archive restoration is in progress see RestoreObject or an archive copy is already restored.
If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For more information about archiving objects, see Transitioning Objects: General Considerations. If the object is stored using server-side encryption either with an Amazon Web Services KMS key or an Amazon S3-managed encryption key, the response includes this header with the value of the server-side encryption algorithm used when storing this object in Amazon S3 for example, AES, aws:kms.
For more information, see Storage Classes. Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.
In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object GetObject or object metadata HeadObject from these buckets, Amazon S3 will return the x-amz-replication-status header in the response as follows:. For more information, see Replication. The Object Lock mode, if any, that's in effect for this object.
This header is only returned if the requester has the s3:GetObjectRetention permission. The date and time when the Object Lock retention period expires. Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold permission.
This header is not returned if the specified version of this object has never had a legal hold applied. Lists the analytics configurations for the bucket.
You can have up to 1, analytics configurations per bucket. This action supports list pagination and does not return more than configurations at a time. You should always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there will be a value in NextContinuationToken.
You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page. The following operations are related to ListBucketAnalyticsConfigurations :. Indicates whether the returned list of analytics configurations is complete.
A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.
The marker that is used as a starting point for this analytics configuration list response. This value is present if it was sent in the request. NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value. The marker used to continue this inventory configuration listing.
Use the NextContinuationToken from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands.
For information about the S3 Intelligent-Tiering storage class, see Storage class for automatically optimizing frequently and infrequently accessed objects. Returns a list of inventory configurations for the bucket. Always check the IsTruncated element in the response. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. The following operations are related to ListBucketInventoryConfigurations :. If sent in the request, the marker that is used as a starting point for this inventory configuration list response.
Specifies the inventory configuration for an Amazon S3 bucket. Tells whether the returned list of inventory configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken is provided for a subsequent request.
Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1, configurations per bucket. The following operations are related to ListBucketMetricsConfigurations :. Indicates whether the returned list of metrics configurations is complete. The marker that is used as a starting point for this metrics configuration list response.
The marker used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. Specifies a metrics configuration for the CloudWatch request metrics specified by the metrics configuration ID from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased.
For more information, see PutBucketMetricsConfiguration. In terms of implementation, a Bucket is a resource. An Amazon S3 bucket name is globally unique, and the namespace is shared by all Amazon Web Services accounts. Date the bucket was created.
This date can change when making changes to your bucket, such as editing its bucket policy. This action lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted. This action returns at most 1, multipart uploads in the response.
You can further limit the number of uploads in a response by specifying the max-uploads parameter in the response. If additional multipart uploads satisfy the list criteria, the response will contain an IsTruncated element with the value true. To list the additional multipart uploads, use the key-marker and upload-id-marker request parameters.
In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time. The following operations are related to ListMultipartUploads :.
All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response. Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.
If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list. If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.
When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request. When a prefix is provided in the request, this field contains the specified prefix.
The result contains only keys starting with the specified prefix. Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response. When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request.
Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.
Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements. Container for the MultipartUpload for the Amazon S3 object.
If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element. The distinct key prefixes are returned in the Prefix child element. Container for all if there are any keys between Prefix and the next occurrence of the string specified by a delimiter. CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.
If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:. The following example specifies the upload-id-marker and key-marker from previous truncated response to retrieve next setup of multipart uploads. Returns metadata about all versions of the objects in a bucket.
You can also use request parameters as selection criteria to return metadata about a subset of all the object versions. To use this operation, you must have permissions to perform the s3:ListBucketVersions action. Be aware of the name difference.
Make sure to design your application to parse the contents of the response and handle it appropriately. The following operations are related to ListObjectVersions :.
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, 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. When the number of responses exceeds the value of MaxKeys , NextKeyMarker specifies the first key not returned that satisfies the search criteria.
Use this value for the key-marker request parameter in a subsequent request. When the number of responses exceeds the value of MaxKeys , NextVersionIdMarker specifies the first object version not returned that satisfies the search criteria. Use this value for the version-id-marker request parameter in a subsequent request. The delimiter grouping the included keys.
A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes.
These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response. All of the keys rolled up into a common prefix count as a single return when calculating the number of returns. The following example return versions of an object with specific key name prefix. The request limits the number of items returned to two.
If there are are more than two object version, S3 returns NextToken in the response. You can specify this token value in your next request to fetch next set of object versions. Returns some or all up to 1, of the objects in a bucket.
You can use the request parameters as selection criteria to return a subset of the objects in a bucket. Be sure to design your application to parse the contents of the response and handle it appropriately.
This action has been revised. We recommend that you use the newer version, ListObjectsV2 , when developing applications. Collectives on Stack Overflow. Learn more. Read file content from S3 bucket with boto3 Ask Question. Asked 5 years, 8 months ago. Active 1 month ago. Viewed k times. Improve this question. Add a comment. Active Oldest Votes. Bucket 'test-bucket' Iterates through all the objects, doing the pagination for you.
Each obj is an ObjectSummary, so it doesn't contain the body. You'll need to call get to get the whole body. Improve this answer. Jordon Phillips Jordon Phillips Is there a way to give the access keys to the resource without using the client? Hafizur Rahman Hafizur Rahman 1, 17 17 silver badges 28 28 bronze badges.
You don't need to specify credentials on the client initialization, it's automatically handled by the boto3 and other AWS SDKs. Which allow users to automatically authenticate with whatever way they choose to could be IAM roles instead — Pedro.
I was stuck for a bit as the decoding didn't work for me s3 objects are gzipped. Cerberussian Cerberussian 91 1 1 silver badge 5 5 bronze badges. Piyush Singhal Piyush Singhal 1 1 silver badge 6 6 bronze badges.
Sign up or log in Sign up using Google. Sign up using Facebook. Sign up using Email and Password. Post as a guest Name. Email Required, but never shown. The Overflow Blog. Podcast Who is building clouds for the independent developer?
0コメント