amazonka-workmail-2.0: Amazon WorkMail SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.WorkMail.DeregisterFromWorkMail

Description

Mark a user, group, or resource as no longer used in WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.

Synopsis

Creating a Request

data DeregisterFromWorkMail Source #

See: newDeregisterFromWorkMail smart constructor.

Constructors

DeregisterFromWorkMail' 

Fields

  • organizationId :: Text

    The identifier for the organization under which the WorkMail entity exists.

  • entityId :: Text

    The identifier for the member (user or group) to be updated.

Instances

Instances details
ToJSON DeregisterFromWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.DeregisterFromWorkMail

Methods

toJSON :: DeregisterFromWorkMail -> Value #

toEncoding :: DeregisterFromWorkMail -> Encoding #

toJSONList :: [DeregisterFromWorkMail] -> Value #

toEncodingList :: [DeregisterFromWorkMail] -> Encoding #

ToHeaders DeregisterFromWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.DeregisterFromWorkMail

Methods

toHeaders :: DeregisterFromWorkMail -> [Header] #

ToPath DeregisterFromWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.DeregisterFromWorkMail

Methods

toPath :: DeregisterFromWorkMail -> ByteString #

ToQuery DeregisterFromWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.DeregisterFromWorkMail

Methods

toQuery :: DeregisterFromWorkMail -> QueryString #

AWSRequest DeregisterFromWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.DeregisterFromWorkMail

Associated Types

type AWSResponse DeregisterFromWorkMail #

Methods

request :: (Service -> Service) -> DeregisterFromWorkMail -> Request DeregisterFromWorkMail #

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

Generic DeregisterFromWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.DeregisterFromWorkMail

Associated Types

type Rep DeregisterFromWorkMail :: Type -> Type #

Methods

from :: DeregisterFromWorkMail -> Rep DeregisterFromWorkMail x #

to :: Rep DeregisterFromWorkMail x -> DeregisterFromWorkMail #

Read DeregisterFromWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.DeregisterFromWorkMail

Methods

readsPrec :: Int -> ReadS DeregisterFromWorkMail #

readList :: ReadS [DeregisterFromWorkMail] #

readPrec :: ReadPrec DeregisterFromWorkMail #

readListPrec :: ReadPrec [DeregisterFromWorkMail] #

Show DeregisterFromWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.DeregisterFromWorkMail

Methods

showsPrec :: Int -> DeregisterFromWorkMail -> ShowS #

show :: DeregisterFromWorkMail -> String #

showList :: [DeregisterFromWorkMail] -> ShowS #

NFData DeregisterFromWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.DeregisterFromWorkMail

Methods

rnf :: DeregisterFromWorkMail -> () #

Eq DeregisterFromWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.DeregisterFromWorkMail

Methods

(==) :: DeregisterFromWorkMail -> DeregisterFromWorkMail -> Bool #

(/=) :: DeregisterFromWorkMail -> DeregisterFromWorkMail -> Bool #

Hashable DeregisterFromWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.DeregisterFromWorkMail

Methods

hashWithSalt :: Int -> DeregisterFromWorkMail -> Int #

hash :: DeregisterFromWorkMail -> Int #

type AWSResponse DeregisterFromWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.DeregisterFromWorkMail

type AWSResponse DeregisterFromWorkMail = DeregisterFromWorkMailResponse
type Rep DeregisterFromWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.DeregisterFromWorkMail

type Rep DeregisterFromWorkMail = D1 ('MetaData "DeregisterFromWorkMail" "Amazonka.WorkMail.DeregisterFromWorkMail" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "DeregisterFromWorkMail'" 'PrefixI 'True) (S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeregisterFromWorkMail Source #

Arguments

:: Text

DeregisterFromWorkMail

-> Text

DeregisterFromWorkMail

-> DeregisterFromWorkMail 

Create a value of DeregisterFromWorkMail 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:

DeregisterFromWorkMail, deregisterFromWorkMail_organizationId - The identifier for the organization under which the WorkMail entity exists.

DeregisterFromWorkMail, deregisterFromWorkMail_entityId - The identifier for the member (user or group) to be updated.

Request Lenses

deregisterFromWorkMail_organizationId :: Lens' DeregisterFromWorkMail Text Source #

The identifier for the organization under which the WorkMail entity exists.

deregisterFromWorkMail_entityId :: Lens' DeregisterFromWorkMail Text Source #

The identifier for the member (user or group) to be updated.

Destructuring the Response

data DeregisterFromWorkMailResponse Source #

See: newDeregisterFromWorkMailResponse smart constructor.

Constructors

DeregisterFromWorkMailResponse' 

Fields

Instances

Instances details
Generic DeregisterFromWorkMailResponse Source # 
Instance details

Defined in Amazonka.WorkMail.DeregisterFromWorkMail

Associated Types

type Rep DeregisterFromWorkMailResponse :: Type -> Type #

Methods

from :: DeregisterFromWorkMailResponse -> Rep DeregisterFromWorkMailResponse x #

to :: Rep DeregisterFromWorkMailResponse x -> DeregisterFromWorkMailResponse #

Read DeregisterFromWorkMailResponse Source # 
Instance details

Defined in Amazonka.WorkMail.DeregisterFromWorkMail

Methods

readsPrec :: Int -> ReadS DeregisterFromWorkMailResponse #

readList :: ReadS [DeregisterFromWorkMailResponse] #

readPrec :: ReadPrec DeregisterFromWorkMailResponse #

readListPrec :: ReadPrec [DeregisterFromWorkMailResponse] #

Show DeregisterFromWorkMailResponse Source # 
Instance details

Defined in Amazonka.WorkMail.DeregisterFromWorkMail

Methods

showsPrec :: Int -> DeregisterFromWorkMailResponse -> ShowS #

show :: DeregisterFromWorkMailResponse -> String #

showList :: [DeregisterFromWorkMailResponse] -> ShowS #

NFData DeregisterFromWorkMailResponse Source # 
Instance details

Defined in Amazonka.WorkMail.DeregisterFromWorkMail

Methods

rnf :: DeregisterFromWorkMailResponse -> () #

Eq DeregisterFromWorkMailResponse Source # 
Instance details

Defined in Amazonka.WorkMail.DeregisterFromWorkMail

Methods

(==) :: DeregisterFromWorkMailResponse -> DeregisterFromWorkMailResponse -> Bool #

(/=) :: DeregisterFromWorkMailResponse -> DeregisterFromWorkMailResponse -> Bool #

type Rep DeregisterFromWorkMailResponse Source # 
Instance details

Defined in Amazonka.WorkMail.DeregisterFromWorkMail

type Rep DeregisterFromWorkMailResponse = D1 ('MetaData "DeregisterFromWorkMailResponse" "Amazonka.WorkMail.DeregisterFromWorkMail" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "DeregisterFromWorkMailResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeregisterFromWorkMailResponse Source #

Arguments

:: Int

$sel:httpStatus:DeregisterFromWorkMailResponse'

-> DeregisterFromWorkMailResponse 

Create a value of DeregisterFromWorkMailResponse 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:DeregisterFromWorkMailResponse', deregisterFromWorkMailResponse_httpStatus - The response's http status code.

Response Lenses

deregisterFromWorkMailResponse_httpStatus :: Lens' DeregisterFromWorkMailResponse Int Source #

The response's http status code.