Amazonka.DirectoryService.DeleteDirectory

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

Contains the inputs for the DeleteDirectory operation.

See: newDeleteDirectory smart constructor.

Constructors

DeleteDirectory'

Fields

• directoryId :: Text

  The identifier of the directory to delete.

Instances

ToJSON DeleteDirectory

Defined in Amazonka.DirectoryService.DeleteDirectory

Methods

toJSON :: DeleteDirectory -> Value

toEncoding :: DeleteDirectory -> Encoding

toJSONList :: [DeleteDirectory] -> Value

toEncodingList :: [DeleteDirectory] -> Encoding

ToHeaders DeleteDirectory

Defined in Amazonka.DirectoryService.DeleteDirectory

Methods

toHeaders :: DeleteDirectory -> [Header]

ToPath DeleteDirectory

Defined in Amazonka.DirectoryService.DeleteDirectory

Methods

toPath :: DeleteDirectory -> ByteString

ToQuery DeleteDirectory

Defined in Amazonka.DirectoryService.DeleteDirectory

Methods

toQuery :: DeleteDirectory -> QueryString

AWSRequest DeleteDirectory

Defined in Amazonka.DirectoryService.DeleteDirectory

Associated Types

type AWSResponse DeleteDirectory

Methods

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

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

Generic DeleteDirectory

Defined in Amazonka.DirectoryService.DeleteDirectory

Associated Types

type Rep DeleteDirectory :: Type -> Type

Methods

from :: DeleteDirectory -> Rep DeleteDirectory x

to :: Rep DeleteDirectory x -> DeleteDirectory

Read DeleteDirectory

Defined in Amazonka.DirectoryService.DeleteDirectory

Methods

readsPrec :: Int -> ReadS DeleteDirectory

readList :: ReadS [DeleteDirectory]

readPrec :: ReadPrec DeleteDirectory

readListPrec :: ReadPrec [DeleteDirectory]

Show DeleteDirectory

Defined in Amazonka.DirectoryService.DeleteDirectory

Methods

showsPrec :: Int -> DeleteDirectory -> ShowS

show :: DeleteDirectory -> String

showList :: [DeleteDirectory] -> ShowS

NFData DeleteDirectory

Defined in Amazonka.DirectoryService.DeleteDirectory

Methods

rnf :: DeleteDirectory -> ()

Eq DeleteDirectory

Defined in Amazonka.DirectoryService.DeleteDirectory

Methods

(==) :: DeleteDirectory -> DeleteDirectory -> Bool

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

Hashable DeleteDirectory

Defined in Amazonka.DirectoryService.DeleteDirectory

Methods

hashWithSalt :: Int -> DeleteDirectory -> Int

hash :: DeleteDirectory -> Int

type AWSResponse DeleteDirectory

Defined in Amazonka.DirectoryService.DeleteDirectory

type AWSResponse DeleteDirectory = DeleteDirectoryResponse

type Rep DeleteDirectory

Defined in Amazonka.DirectoryService.DeleteDirectory

type Rep DeleteDirectory = D1 ('MetaData "DeleteDirectory" "Amazonka.DirectoryService.DeleteDirectory" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" 'False) (C1 ('MetaCons "DeleteDirectory'" 'PrefixI 'True) (S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteDirectory

Arguments

:: Text

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:

DeleteDirectory, deleteDirectory_directoryId - The identifier of the directory to delete.

Request Lenses

deleteDirectory_directoryId :: Lens' DeleteDirectory Text

The identifier of the directory to delete.

Destructuring the Response

data DeleteDirectoryResponse

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

Generic DeleteDirectoryResponse

Defined in Amazonka.DirectoryService.DeleteDirectory

Associated Types

type Rep DeleteDirectoryResponse :: Type -> Type

Methods

from :: DeleteDirectoryResponse -> Rep DeleteDirectoryResponse x

to :: Rep DeleteDirectoryResponse x -> DeleteDirectoryResponse

Read DeleteDirectoryResponse

Defined in Amazonka.DirectoryService.DeleteDirectory

Methods

readsPrec :: Int -> ReadS DeleteDirectoryResponse

readList :: ReadS [DeleteDirectoryResponse]

readPrec :: ReadPrec DeleteDirectoryResponse

readListPrec :: ReadPrec [DeleteDirectoryResponse]

Show DeleteDirectoryResponse

Defined in Amazonka.DirectoryService.DeleteDirectory

Methods

showsPrec :: Int -> DeleteDirectoryResponse -> ShowS

show :: DeleteDirectoryResponse -> String

showList :: [DeleteDirectoryResponse] -> ShowS

NFData DeleteDirectoryResponse

Defined in Amazonka.DirectoryService.DeleteDirectory

Methods

rnf :: DeleteDirectoryResponse -> ()

Eq DeleteDirectoryResponse

Defined in Amazonka.DirectoryService.DeleteDirectory

Methods

(==) :: DeleteDirectoryResponse -> DeleteDirectoryResponse -> Bool

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

type Rep DeleteDirectoryResponse

Defined in Amazonka.DirectoryService.DeleteDirectory

type Rep DeleteDirectoryResponse = D1 ('MetaData "DeleteDirectoryResponse" "Amazonka.DirectoryService.DeleteDirectory" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" '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

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:

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)

The directory identifier.

deleteDirectoryResponse_httpStatus :: Lens' DeleteDirectoryResponse Int

The response's http status code.