Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudDirectory.DeleteObject

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted. The maximum number of attributes that can be deleted during an object deletion is 30. For more information, see Amazon Cloud Directory Limits.

Creating a Request

data DeleteObject Source #

See: newDeleteObject smart constructor.

Constructors

DeleteObject'
Fields directoryArn :: Text The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns. objectReference :: ObjectReference A reference that identifies the object.

Instances

Instances details

ToJSON DeleteObject Source #
Instance details Defined in Amazonka.CloudDirectory.DeleteObject Methods toJSON :: DeleteObject -> Value # toEncoding :: DeleteObject -> Encoding # toJSONList :: [DeleteObject] -> Value # toEncodingList :: [DeleteObject] -> Encoding #
ToHeaders DeleteObject Source #
Instance details Defined in Amazonka.CloudDirectory.DeleteObject Methods toHeaders :: DeleteObject -> [Header] #
ToPath DeleteObject Source #
Instance details Defined in Amazonka.CloudDirectory.DeleteObject Methods toPath :: DeleteObject -> ByteString #
ToQuery DeleteObject Source #
Instance details Defined in Amazonka.CloudDirectory.DeleteObject Methods toQuery :: DeleteObject -> QueryString #
AWSRequest DeleteObject Source #
Instance details Defined in Amazonka.CloudDirectory.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 Source #
Instance details Defined in Amazonka.CloudDirectory.DeleteObject Associated Types type Rep DeleteObject :: Type -> Type # Methods from :: DeleteObject -> Rep DeleteObject x # to :: Rep DeleteObject x -> DeleteObject #
Read DeleteObject Source #
Instance details Defined in Amazonka.CloudDirectory.DeleteObject Methods readsPrec :: Int -> ReadS DeleteObject # readList :: ReadS [DeleteObject] # readPrec :: ReadPrec DeleteObject # readListPrec :: ReadPrec [DeleteObject] #
Show DeleteObject Source #
Instance details Defined in Amazonka.CloudDirectory.DeleteObject Methods showsPrec :: Int -> DeleteObject -> ShowS # show :: DeleteObject -> String # showList :: [DeleteObject] -> ShowS #
NFData DeleteObject Source #
Instance details Defined in Amazonka.CloudDirectory.DeleteObject Methods rnf :: DeleteObject -> () #
Eq DeleteObject Source #
Instance details Defined in Amazonka.CloudDirectory.DeleteObject Methods (==) :: DeleteObject -> DeleteObject -> Bool # (/=) :: DeleteObject -> DeleteObject -> Bool #
Hashable DeleteObject Source #
Instance details Defined in Amazonka.CloudDirectory.DeleteObject Methods hashWithSalt :: Int -> DeleteObject -> Int # hash :: DeleteObject -> Int #
type AWSResponse DeleteObject Source #
Instance details Defined in Amazonka.CloudDirectory.DeleteObject type AWSResponse DeleteObject = DeleteObjectResponse
type Rep DeleteObject Source #
Instance details Defined in Amazonka.CloudDirectory.DeleteObject type Rep DeleteObject = D1 ('MetaData "DeleteObject" "Amazonka.CloudDirectory.DeleteObject" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "DeleteObject'" 'PrefixI 'True) (S1 ('MetaSel ('Just "directoryArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "objectReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ObjectReference)))

newDeleteObject Source #

Arguments

:: Text	`DeleteObject`
-> ObjectReference	`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:

DeleteObject, deleteObject_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

DeleteObject, deleteObject_objectReference - A reference that identifies the object.

Request Lenses

deleteObject_directoryArn :: Lens' DeleteObject Text Source #

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

deleteObject_objectReference :: Lens' DeleteObject ObjectReference Source #

A reference that identifies the object.

Destructuring the Response

data DeleteObjectResponse Source #

See: newDeleteObjectResponse smart constructor.

Constructors

DeleteObjectResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DeleteObjectResponse Source #
Instance details Defined in Amazonka.CloudDirectory.DeleteObject Associated Types type Rep DeleteObjectResponse :: Type -> Type # Methods from :: DeleteObjectResponse -> Rep DeleteObjectResponse x # to :: Rep DeleteObjectResponse x -> DeleteObjectResponse #
Read DeleteObjectResponse Source #
Instance details Defined in Amazonka.CloudDirectory.DeleteObject Methods readsPrec :: Int -> ReadS DeleteObjectResponse # readList :: ReadS [DeleteObjectResponse] # readPrec :: ReadPrec DeleteObjectResponse # readListPrec :: ReadPrec [DeleteObjectResponse] #
Show DeleteObjectResponse Source #
Instance details Defined in Amazonka.CloudDirectory.DeleteObject Methods showsPrec :: Int -> DeleteObjectResponse -> ShowS # show :: DeleteObjectResponse -> String # showList :: [DeleteObjectResponse] -> ShowS #
NFData DeleteObjectResponse Source #
Instance details Defined in Amazonka.CloudDirectory.DeleteObject Methods rnf :: DeleteObjectResponse -> () #
Eq DeleteObjectResponse Source #
Instance details Defined in Amazonka.CloudDirectory.DeleteObject Methods (==) :: DeleteObjectResponse -> DeleteObjectResponse -> Bool # (/=) :: DeleteObjectResponse -> DeleteObjectResponse -> Bool #
type Rep DeleteObjectResponse Source #
Instance details Defined in Amazonka.CloudDirectory.DeleteObject type Rep DeleteObjectResponse = D1 ('MetaData "DeleteObjectResponse" "Amazonka.CloudDirectory.DeleteObject" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "DeleteObjectResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteObjectResponse Source #

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:

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

Response Lenses

deleteObjectResponse_httpStatus :: Lens' DeleteObjectResponse Int Source #

The response's http status code.