amazonka-workmail-1.6.1: Amazon WorkMail SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.WorkMail.DescribeOrganization

Contents

Description

Provides more information regarding a given organization based on its identifier.

Synopsis

Creating a Request

describeOrganization Source #

Creates a value of DescribeOrganization with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data DescribeOrganization Source #

See: describeOrganization smart constructor.

Instances
Eq DescribeOrganization Source # 
Instance details

Defined in Network.AWS.WorkMail.DescribeOrganization

Data DescribeOrganization Source # 
Instance details

Defined in Network.AWS.WorkMail.DescribeOrganization

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeOrganization -> c DescribeOrganization #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeOrganization #

toConstr :: DescribeOrganization -> Constr #

dataTypeOf :: DescribeOrganization -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeOrganization) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeOrganization) #

gmapT :: (forall b. Data b => b -> b) -> DescribeOrganization -> DescribeOrganization #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeOrganization -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeOrganization -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeOrganization -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeOrganization -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeOrganization -> m DescribeOrganization #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeOrganization -> m DescribeOrganization #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeOrganization -> m DescribeOrganization #

Read DescribeOrganization Source # 
Instance details

Defined in Network.AWS.WorkMail.DescribeOrganization

Show DescribeOrganization Source # 
Instance details

Defined in Network.AWS.WorkMail.DescribeOrganization

Generic DescribeOrganization Source # 
Instance details

Defined in Network.AWS.WorkMail.DescribeOrganization

Associated Types

type Rep DescribeOrganization :: Type -> Type #

Hashable DescribeOrganization Source # 
Instance details

Defined in Network.AWS.WorkMail.DescribeOrganization

ToJSON DescribeOrganization Source # 
Instance details

Defined in Network.AWS.WorkMail.DescribeOrganization

AWSRequest DescribeOrganization Source # 
Instance details

Defined in Network.AWS.WorkMail.DescribeOrganization

Associated Types

type Rs DescribeOrganization :: Type #

ToHeaders DescribeOrganization Source # 
Instance details

Defined in Network.AWS.WorkMail.DescribeOrganization

ToPath DescribeOrganization Source # 
Instance details

Defined in Network.AWS.WorkMail.DescribeOrganization

ToQuery DescribeOrganization Source # 
Instance details

Defined in Network.AWS.WorkMail.DescribeOrganization

NFData DescribeOrganization Source # 
Instance details

Defined in Network.AWS.WorkMail.DescribeOrganization

Methods

rnf :: DescribeOrganization -> () #

type Rep DescribeOrganization Source # 
Instance details

Defined in Network.AWS.WorkMail.DescribeOrganization

type Rep DescribeOrganization = D1 (MetaData "DescribeOrganization" "Network.AWS.WorkMail.DescribeOrganization" "amazonka-workmail-1.6.1-9RRutGyw1Wr48gbVhlSAOF" True) (C1 (MetaCons "DescribeOrganization'" PrefixI True) (S1 (MetaSel (Just "_doOrganizationId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type Rs DescribeOrganization Source # 
Instance details

Defined in Network.AWS.WorkMail.DescribeOrganization

Request Lenses

doOrganizationId :: Lens' DescribeOrganization Text Source #

The identifier for the organization to be described.

Destructuring the Response

describeOrganizationResponse Source #

Creates a value of DescribeOrganizationResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dorsDirectoryId - The identifier for the directory associated with an Amazon WorkMail organization.
  • dorsState - The state of an organization.
  • dorsAlias - The alias for an organization.
  • dorsCompletedDate - The date at which the organization became usable in the Amazon WorkMail context, in UNIX epoch time format.
  • dorsDirectoryType - The type of directory associated with the Amazon WorkMail organization.
  • dorsDefaultMailDomain - The default mail domain associated with the organization.
  • dorsErrorMessage - The (optional) error message indicating if unexpected behavior was encountered with regards to the organization.
  • dorsOrganizationId - The identifier of an organization.
  • dorsResponseStatus - -- | The response status code.

data DescribeOrganizationResponse Source #

See: describeOrganizationResponse smart constructor.

Instances
Eq DescribeOrganizationResponse Source # 
Instance details

Defined in Network.AWS.WorkMail.DescribeOrganization

Data DescribeOrganizationResponse Source # 
Instance details

Defined in Network.AWS.WorkMail.DescribeOrganization

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeOrganizationResponse -> c DescribeOrganizationResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeOrganizationResponse #

toConstr :: DescribeOrganizationResponse -> Constr #

dataTypeOf :: DescribeOrganizationResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeOrganizationResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeOrganizationResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeOrganizationResponse -> DescribeOrganizationResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeOrganizationResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeOrganizationResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeOrganizationResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeOrganizationResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeOrganizationResponse -> m DescribeOrganizationResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeOrganizationResponse -> m DescribeOrganizationResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeOrganizationResponse -> m DescribeOrganizationResponse #

Read DescribeOrganizationResponse Source # 
Instance details

Defined in Network.AWS.WorkMail.DescribeOrganization

Show DescribeOrganizationResponse Source # 
Instance details

Defined in Network.AWS.WorkMail.DescribeOrganization

Generic DescribeOrganizationResponse Source # 
Instance details

Defined in Network.AWS.WorkMail.DescribeOrganization

Associated Types

type Rep DescribeOrganizationResponse :: Type -> Type #

NFData DescribeOrganizationResponse Source # 
Instance details

Defined in Network.AWS.WorkMail.DescribeOrganization

type Rep DescribeOrganizationResponse Source # 
Instance details

Defined in Network.AWS.WorkMail.DescribeOrganization

type Rep DescribeOrganizationResponse = D1 (MetaData "DescribeOrganizationResponse" "Network.AWS.WorkMail.DescribeOrganization" "amazonka-workmail-1.6.1-9RRutGyw1Wr48gbVhlSAOF" False) (C1 (MetaCons "DescribeOrganizationResponse'" PrefixI True) (((S1 (MetaSel (Just "_dorsDirectoryId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dorsState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_dorsAlias") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dorsCompletedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 (MetaSel (Just "_dorsDirectoryType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dorsDefaultMailDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_dorsErrorMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_dorsOrganizationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dorsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))))

Response Lenses

dorsDirectoryId :: Lens' DescribeOrganizationResponse (Maybe Text) Source #

The identifier for the directory associated with an Amazon WorkMail organization.

dorsState :: Lens' DescribeOrganizationResponse (Maybe Text) Source #

The state of an organization.

dorsAlias :: Lens' DescribeOrganizationResponse (Maybe Text) Source #

The alias for an organization.

dorsCompletedDate :: Lens' DescribeOrganizationResponse (Maybe UTCTime) Source #

The date at which the organization became usable in the Amazon WorkMail context, in UNIX epoch time format.

dorsDirectoryType :: Lens' DescribeOrganizationResponse (Maybe Text) Source #

The type of directory associated with the Amazon WorkMail organization.

dorsDefaultMailDomain :: Lens' DescribeOrganizationResponse (Maybe Text) Source #

The default mail domain associated with the organization.

dorsErrorMessage :: Lens' DescribeOrganizationResponse (Maybe Text) Source #

The (optional) error message indicating if unexpected behavior was encountered with regards to the organization.

dorsOrganizationId :: Lens' DescribeOrganizationResponse (Maybe Text) Source #

The identifier of an organization.