openapi: 3.1.0 info: title: Amazon S3 Attributes (object-level) description: '1 operations from the Amazon S3 REST API, generated from the authoritative service model. S3 identifies these operations by the `attributes` query subresource, which is declared as a required query parameter on each one because an OpenAPI path cannot carry a query string. Generated from boto/botocore `service-2.json` at `aeb03fc4ae530e0b3f47d588b6021581db870c8c` (Apache-2.0). Responses are XML.' version: '2006-03-01' contact: name: AWS Support url: https://aws.amazon.com/premiumsupport/ externalDocs: description: Amazon S3 API Reference url: https://docs.aws.amazon.com/AmazonS3/latest/API/ servers: - url: https://s3.{region}.amazonaws.com variables: region: default: us-east-1 tags: - name: attributes paths: /{Bucket}/{Key}: get: operationId: GetObjectAttributes summary: Retrieves all of the metadata from an object without returning the object itself. This operation is useful if you're int description: Retrieves all of the metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata. GetObjectAttributes combines the functionality of HeadObject and ListParts. All of the data returned with both of those individual calls can be returned with a single call to GetObjectAttributes. Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide. Permissions General purpose bucket permissions - To use GetObjectAttributes, you must have READ access to the object. The other permissions that you need to use this operation depend on whether the bucket is versioned and if a version ID is passe tags: - attributes parameters: - name: attributes in: query required: true description: Selects this operation. S3 identifies it by the `attributes` subresource. schema: type: string - name: Bucket in: path required: true description: The name of the bucket that contains the object. Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express schema: type: string - name: Key in: path required: true description: The object key. schema: type: string - name: versionId in: query required: false description: The version ID used to reference a specific version of the object. S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is sup schema: type: string - name: x-amz-max-parts in: header required: false description: Sets the maximum number of parts to return. For more information, see Uploading and copying objects using multipart upload in Amazon S3 in the Amazon Simple Storage Service user guide. schema: type: integer - name: x-amz-part-number-marker in: header required: false description: 'Specifies the part after which listing should begin. Only parts with higher part numbers will be listed. For more information, see Uploading and copying objects using multipart upload in Amazon S3 in ' schema: type: integer - name: x-amz-server-side-encryption-customer-algorithm in: header required: false description: Specifies the algorithm to use when encrypting the object (for example, AES256). This functionality is not supported for directory buckets. schema: type: string - name: x-amz-server-side-encryption-customer-key in: header required: false description: Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. Th schema: type: string - name: x-amz-server-side-encryption-customer-key-MD5 in: header required: false description: 'Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error. ' schema: type: string - name: x-amz-request-payer in: header required: false schema: type: string enum: - requester - name: x-amz-expected-bucket-owner in: header required: false description: The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied) schema: type: string - name: x-amz-object-attributes in: header required: true description: Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned. schema: type: string responses: '200': description: Success. S3 answers in XML, not JSON. x-output-shape: GetObjectAttributesOutput '403': description: AccessDenied. S3 validates the signature before it routes the operation, so this does not distinguish an unsupported operation from an unauthorised one. x-s3-greedy-path-segment: 'AWS writes this route as `/{Bucket}/{Key+}`. The trailing `+` marks a greedy segment, which OpenAPI templating cannot express: an S3 object key may contain slashes, so this parameter is not a single path component.'