Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DirectoryService.DeleteDirectory

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes an Directory Service directory.

Before you call DeleteDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the DeleteDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.

Creating a Request

data DeleteDirectory Source #

Contains the inputs for the DeleteDirectory operation.

See: newDeleteDirectory smart constructor.

Constructors

DeleteDirectory'
Fields directoryId :: Text The identifier of the directory to delete.

Instances

Instances details

Eq DeleteDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DeleteDirectory Methods (==) :: DeleteDirectory -> DeleteDirectory -> Bool # (/=) :: DeleteDirectory -> DeleteDirectory -> Bool #
Read DeleteDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DeleteDirectory Methods readsPrec :: Int -> ReadS DeleteDirectory # readList :: ReadS [DeleteDirectory] # readPrec :: ReadPrec DeleteDirectory # readListPrec :: ReadPrec [DeleteDirectory] #
Show DeleteDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DeleteDirectory Methods showsPrec :: Int -> DeleteDirectory -> ShowS # show :: DeleteDirectory -> String # showList :: [DeleteDirectory] -> ShowS #
Generic DeleteDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DeleteDirectory Associated Types type Rep DeleteDirectory :: Type -> Type # Methods from :: DeleteDirectory -> Rep DeleteDirectory x # to :: Rep DeleteDirectory x -> DeleteDirectory #
NFData DeleteDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DeleteDirectory Methods rnf :: DeleteDirectory -> () #
Hashable DeleteDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DeleteDirectory Methods hashWithSalt :: Int -> DeleteDirectory -> Int # hash :: DeleteDirectory -> Int #
ToJSON DeleteDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DeleteDirectory Methods toJSON :: DeleteDirectory -> Value # toEncoding :: DeleteDirectory -> Encoding # toJSONList :: [DeleteDirectory] -> Value # toEncodingList :: [DeleteDirectory] -> Encoding #
AWSRequest DeleteDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DeleteDirectory Associated Types type AWSResponse DeleteDirectory # Methods request :: DeleteDirectory -> Request DeleteDirectory # response :: MonadResource m => Logger -> Service -> Proxy DeleteDirectory -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteDirectory))) #
ToHeaders DeleteDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DeleteDirectory Methods toHeaders :: DeleteDirectory -> [Header] #
ToPath DeleteDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DeleteDirectory Methods toPath :: DeleteDirectory -> ByteString #
ToQuery DeleteDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DeleteDirectory Methods toQuery :: DeleteDirectory -> QueryString #
type Rep DeleteDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DeleteDirectory type Rep DeleteDirectory = D1 ('MetaData "DeleteDirectory" "Amazonka.DirectoryService.DeleteDirectory" "libZSservicesZSamazonka-dsZSamazonka-ds" 'False) (C1 ('MetaCons "DeleteDirectory'" 'PrefixI 'True) (S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DeleteDirectory type AWSResponse DeleteDirectory = DeleteDirectoryResponse

newDeleteDirectory Source #

Arguments

:: Text	`$sel:directoryId:DeleteDirectory'`
-> DeleteDirectory

Create a value of DeleteDirectory 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:directoryId:DeleteDirectory', deleteDirectory_directoryId - The identifier of the directory to delete.

Request Lenses

deleteDirectory_directoryId :: Lens' DeleteDirectory Text Source #

The identifier of the directory to delete.

Destructuring the Response

data DeleteDirectoryResponse Source #

Contains the results of the DeleteDirectory operation.

See: newDeleteDirectoryResponse smart constructor.

Constructors

DeleteDirectoryResponse'
Fields directoryId :: Maybe Text The directory identifier. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DeleteDirectoryResponse Source #
Instance details Defined in Amazonka.DirectoryService.DeleteDirectory Methods (==) :: DeleteDirectoryResponse -> DeleteDirectoryResponse -> Bool # (/=) :: DeleteDirectoryResponse -> DeleteDirectoryResponse -> Bool #
Read DeleteDirectoryResponse Source #
Instance details Defined in Amazonka.DirectoryService.DeleteDirectory Methods readsPrec :: Int -> ReadS DeleteDirectoryResponse # readList :: ReadS [DeleteDirectoryResponse] # readPrec :: ReadPrec DeleteDirectoryResponse # readListPrec :: ReadPrec [DeleteDirectoryResponse] #
Show DeleteDirectoryResponse Source #
Instance details Defined in Amazonka.DirectoryService.DeleteDirectory Methods showsPrec :: Int -> DeleteDirectoryResponse -> ShowS # show :: DeleteDirectoryResponse -> String # showList :: [DeleteDirectoryResponse] -> ShowS #
Generic DeleteDirectoryResponse Source #
Instance details Defined in Amazonka.DirectoryService.DeleteDirectory Associated Types type Rep DeleteDirectoryResponse :: Type -> Type # Methods from :: DeleteDirectoryResponse -> Rep DeleteDirectoryResponse x # to :: Rep DeleteDirectoryResponse x -> DeleteDirectoryResponse #
NFData DeleteDirectoryResponse Source #
Instance details Defined in Amazonka.DirectoryService.DeleteDirectory Methods rnf :: DeleteDirectoryResponse -> () #
type Rep DeleteDirectoryResponse Source #
Instance details Defined in Amazonka.DirectoryService.DeleteDirectory type Rep DeleteDirectoryResponse = D1 ('MetaData "DeleteDirectoryResponse" "Amazonka.DirectoryService.DeleteDirectory" "libZSservicesZSamazonka-dsZSamazonka-ds" 'False) (C1 ('MetaCons "DeleteDirectoryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteDirectoryResponse Source #

Arguments

:: Int	`$sel:httpStatus:DeleteDirectoryResponse'`
-> DeleteDirectoryResponse

Create a value of DeleteDirectoryResponse 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:directoryId:DeleteDirectory', deleteDirectoryResponse_directoryId - The directory identifier.

$sel:httpStatus:DeleteDirectoryResponse', deleteDirectoryResponse_httpStatus - The response's http status code.

Response Lenses

deleteDirectoryResponse_directoryId :: Lens' DeleteDirectoryResponse (Maybe Text) Source #

The directory identifier.

deleteDirectoryResponse_httpStatus :: Lens' DeleteDirectoryResponse Int Source #

The response's http status code.