Amazonka.S3.DeleteObject

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 version, Amazon S3 does not remove any objects but will still respond that the command was successful.

To remove a specific version, you must be the bucket owner and you must use the version Id subresource. Using this subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, to true.

If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, you must include the x-amz-mfa request header in the DELETE versionId request. Requests that include x-amz-mfa must use HTTPS.

For more information about MFA Delete, see Using MFA Delete. To see sample requests that use versioning, see Sample Request.

You can delete objects by explicitly calling DELETE Object or configure its lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration actions.

The following action is related to DeleteObject:

• PutObject

Creating a Request

data DeleteObject

See: newDeleteObject smart constructor.

Constructors

DeleteObject'

Fields

• bypassGovernanceRetention :: Maybe Bool

  Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the s3:BypassGovernanceRetention permission.

• expectedBucketOwner :: Maybe Text

  The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• mfa :: Maybe Text

  The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

• requestPayer :: Maybe RequestPayer
• versionId :: Maybe ObjectVersionId

  VersionId used to reference a specific version of the object.

• bucket :: BucketName

  The bucket name of the bucket containing the object.

  When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

  When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

• key :: ObjectKey

  Key name of the object to delete.

Instances

ToHeaders DeleteObject

Defined in Amazonka.S3.DeleteObject

Methods

toHeaders :: DeleteObject -> [Header]

ToPath DeleteObject

Defined in Amazonka.S3.DeleteObject

Methods

toPath :: DeleteObject -> ByteString

ToQuery DeleteObject

Defined in Amazonka.S3.DeleteObject

Methods

toQuery :: DeleteObject -> QueryString

AWSRequest DeleteObject

Defined in Amazonka.S3.DeleteObject

Associated Types

type AWSResponse DeleteObject

Methods

request :: (Service -> Service) -> DeleteObject -> Request DeleteObject

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteObject -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteObject)))

Generic DeleteObject

Defined in Amazonka.S3.DeleteObject

Associated Types

type Rep DeleteObject :: Type -> Type

Methods

from :: DeleteObject -> Rep DeleteObject x

to :: Rep DeleteObject x -> DeleteObject

Read DeleteObject

Defined in Amazonka.S3.DeleteObject

Methods

readsPrec :: Int -> ReadS DeleteObject

readList :: ReadS [DeleteObject]

readPrec :: ReadPrec DeleteObject

readListPrec :: ReadPrec [DeleteObject]

Show DeleteObject

Defined in Amazonka.S3.DeleteObject

Methods

showsPrec :: Int -> DeleteObject -> ShowS

show :: DeleteObject -> String

showList :: [DeleteObject] -> ShowS

NFData DeleteObject

Defined in Amazonka.S3.DeleteObject

Methods

rnf :: DeleteObject -> ()

Eq DeleteObject

Defined in Amazonka.S3.DeleteObject

Methods

(==) :: DeleteObject -> DeleteObject -> Bool

(/=) :: DeleteObject -> DeleteObject -> Bool

Hashable DeleteObject

Defined in Amazonka.S3.DeleteObject

Methods

hashWithSalt :: Int -> DeleteObject -> Int

hash :: DeleteObject -> Int

type AWSResponse DeleteObject

Defined in Amazonka.S3.DeleteObject

type AWSResponse DeleteObject = DeleteObjectResponse

type Rep DeleteObject

Defined in Amazonka.S3.DeleteObject

type Rep DeleteObject = D1 ('MetaData "DeleteObject" "Amazonka.S3.DeleteObject" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "DeleteObject'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "bypassGovernanceRetention") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "expectedBucketOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "mfa") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "requestPayer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestPayer)) :*: S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectVersionId))) :*: (S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BucketName) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ObjectKey)))))

newDeleteObject

Arguments

:: BucketName

DeleteObject

-> ObjectKey

DeleteObject

-> DeleteObject

Create a value of DeleteObject with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:bypassGovernanceRetention:DeleteObject', deleteObject_bypassGovernanceRetention - Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the s3:BypassGovernanceRetention permission.

$sel:expectedBucketOwner:DeleteObject', deleteObject_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

$sel:mfa:DeleteObject', deleteObject_mfa - The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

$sel:requestPayer:DeleteObject', deleteObject_requestPayer - Undocumented member.

DeleteObject, deleteObject_versionId - VersionId used to reference a specific version of the object.

DeleteObject, deleteObject_bucket - The bucket name of the bucket containing the object.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

DeleteObject, deleteObject_key - Key name of the object to delete.

Request Lenses

deleteObject_bypassGovernanceRetention :: Lens' DeleteObject (Maybe Bool)

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the s3:BypassGovernanceRetention permission.

deleteObject_expectedBucketOwner :: Lens' DeleteObject (Maybe Text)

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

deleteObject_mfa :: Lens' DeleteObject (Maybe Text)

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

deleteObject_requestPayer :: Lens' DeleteObject (Maybe RequestPayer)

Undocumented member.

deleteObject_versionId :: Lens' DeleteObject (Maybe ObjectVersionId)

VersionId used to reference a specific version of the object.

deleteObject_bucket :: Lens' DeleteObject BucketName

The bucket name of the bucket containing the object.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

deleteObject_key :: Lens' DeleteObject ObjectKey

Key name of the object to delete.

Destructuring the Response

data DeleteObjectResponse

See: newDeleteObjectResponse smart constructor.

Constructors

DeleteObjectResponse'

Fields

• deleteMarker :: Maybe Bool

  Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker.

• requestCharged :: Maybe RequestCharged
• versionId :: Maybe ObjectVersionId

  Returns the version ID of the delete marker created as a result of the DELETE operation.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DeleteObjectResponse

Defined in Amazonka.S3.DeleteObject

Associated Types

type Rep DeleteObjectResponse :: Type -> Type

Methods

from :: DeleteObjectResponse -> Rep DeleteObjectResponse x

to :: Rep DeleteObjectResponse x -> DeleteObjectResponse

Read DeleteObjectResponse

Defined in Amazonka.S3.DeleteObject

Methods

readsPrec :: Int -> ReadS DeleteObjectResponse

readList :: ReadS [DeleteObjectResponse]

readPrec :: ReadPrec DeleteObjectResponse

readListPrec :: ReadPrec [DeleteObjectResponse]

Show DeleteObjectResponse

Defined in Amazonka.S3.DeleteObject

Methods

showsPrec :: Int -> DeleteObjectResponse -> ShowS

show :: DeleteObjectResponse -> String

showList :: [DeleteObjectResponse] -> ShowS

NFData DeleteObjectResponse

Defined in Amazonka.S3.DeleteObject

Methods

rnf :: DeleteObjectResponse -> ()

Eq DeleteObjectResponse

Defined in Amazonka.S3.DeleteObject

Methods

(==) :: DeleteObjectResponse -> DeleteObjectResponse -> Bool

(/=) :: DeleteObjectResponse -> DeleteObjectResponse -> Bool

type Rep DeleteObjectResponse

Defined in Amazonka.S3.DeleteObject

type Rep DeleteObjectResponse = D1 ('MetaData "DeleteObjectResponse" "Amazonka.S3.DeleteObject" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "DeleteObjectResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "deleteMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "requestCharged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestCharged))) :*: (S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectVersionId)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDeleteObjectResponse

Arguments

:: Int

$sel:httpStatus:DeleteObjectResponse'

-> DeleteObjectResponse

Create a value of DeleteObjectResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteObjectResponse, deleteObjectResponse_deleteMarker - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker.

$sel:requestCharged:DeleteObjectResponse', deleteObjectResponse_requestCharged - Undocumented member.

DeleteObject, deleteObjectResponse_versionId - Returns the version ID of the delete marker created as a result of the DELETE operation.

$sel:httpStatus:DeleteObjectResponse', deleteObjectResponse_httpStatus - The response's http status code.

Response Lenses

deleteObjectResponse_deleteMarker :: Lens' DeleteObjectResponse (Maybe Bool)

Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker.

deleteObjectResponse_requestCharged :: Lens' DeleteObjectResponse (Maybe RequestCharged)

Undocumented member.

deleteObjectResponse_versionId :: Lens' DeleteObjectResponse (Maybe ObjectVersionId)

Returns the version ID of the delete marker created as a result of the DELETE operation.

deleteObjectResponse_httpStatus :: Lens' DeleteObjectResponse Int

The response's http status code.