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.WorkMail.DescribeOrganization

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data DescribeOrganization = DescribeOrganization' {
- organizationId :: Text
}
newDescribeOrganization :: Text -> DescribeOrganization
describeOrganization_organizationId :: Lens' DescribeOrganization Text
data DescribeOrganizationResponse = DescribeOrganizationResponse' {
- directoryId :: Maybe Text
- state :: Maybe Text
- arn :: Maybe Text
- alias :: Maybe Text
- completedDate :: Maybe POSIX
- directoryType :: Maybe Text
- defaultMailDomain :: Maybe Text
- errorMessage :: Maybe Text
- organizationId :: Maybe Text
- httpStatus :: Int
}
newDescribeOrganizationResponse :: Int -> DescribeOrganizationResponse
describeOrganizationResponse_directoryId :: Lens' DescribeOrganizationResponse (Maybe Text)
describeOrganizationResponse_state :: Lens' DescribeOrganizationResponse (Maybe Text)
describeOrganizationResponse_arn :: Lens' DescribeOrganizationResponse (Maybe Text)
describeOrganizationResponse_alias :: Lens' DescribeOrganizationResponse (Maybe Text)
describeOrganizationResponse_completedDate :: Lens' DescribeOrganizationResponse (Maybe UTCTime)
describeOrganizationResponse_directoryType :: Lens' DescribeOrganizationResponse (Maybe Text)
describeOrganizationResponse_defaultMailDomain :: Lens' DescribeOrganizationResponse (Maybe Text)
describeOrganizationResponse_errorMessage :: Lens' DescribeOrganizationResponse (Maybe Text)
describeOrganizationResponse_organizationId :: Lens' DescribeOrganizationResponse (Maybe Text)
describeOrganizationResponse_httpStatus :: Lens' DescribeOrganizationResponse Int

Creating a Request

data DescribeOrganization Source #

See: newDescribeOrganization smart constructor.

Constructors

DescribeOrganization'
Fields organizationId :: Text The identifier for the organization to be described.

Instances

Instances details

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

newDescribeOrganization Source #

Arguments

:: Text	`$sel:organizationId:DescribeOrganization'`
-> DescribeOrganization

Create a value of DescribeOrganization 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:organizationId:DescribeOrganization', describeOrganization_organizationId - The identifier for the organization to be described.

Request Lenses

describeOrganization_organizationId :: Lens' DescribeOrganization Text Source #

The identifier for the organization to be described.

Destructuring the Response

data DescribeOrganizationResponse Source #

See: newDescribeOrganizationResponse smart constructor.

Constructors

DescribeOrganizationResponse'

Fields

directoryId :: Maybe Text
The identifier for the directory associated with an Amazon WorkMail organization.
state :: Maybe Text
The state of an organization.
arn :: Maybe Text
The Amazon Resource Name (ARN) of the organization.
alias :: Maybe Text
The alias for an organization.
completedDate :: Maybe POSIX
The date at which the organization became usable in the WorkMail context, in UNIX epoch time format.
directoryType :: Maybe Text
The type of directory associated with the WorkMail organization.
defaultMailDomain :: Maybe Text
The default mail domain associated with the organization.
errorMessage :: Maybe Text
(Optional) The error message indicating if unexpected behavior was encountered with regards to the organization.
organizationId :: Maybe Text
The identifier of an organization.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeOrganizationResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeOrganization Methods (==) :: DescribeOrganizationResponse -> DescribeOrganizationResponse -> Bool # (/=) :: DescribeOrganizationResponse -> DescribeOrganizationResponse -> Bool #
Read DescribeOrganizationResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeOrganization Methods readsPrec :: Int -> ReadS DescribeOrganizationResponse # readList :: ReadS [DescribeOrganizationResponse] # readPrec :: ReadPrec DescribeOrganizationResponse # readListPrec :: ReadPrec [DescribeOrganizationResponse] #
Show DescribeOrganizationResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeOrganization Methods showsPrec :: Int -> DescribeOrganizationResponse -> ShowS # show :: DescribeOrganizationResponse -> String # showList :: [DescribeOrganizationResponse] -> ShowS #
Generic DescribeOrganizationResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeOrganization Associated Types type Rep DescribeOrganizationResponse :: Type -> Type # Methods from :: DescribeOrganizationResponse -> Rep DescribeOrganizationResponse x # to :: Rep DescribeOrganizationResponse x -> DescribeOrganizationResponse #
NFData DescribeOrganizationResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeOrganization Methods rnf :: DescribeOrganizationResponse -> () #
type Rep DescribeOrganizationResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeOrganization type Rep DescribeOrganizationResponse = D1 ('MetaData "DescribeOrganizationResponse" "Amazonka.WorkMail.DescribeOrganization" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "DescribeOrganizationResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "completedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :: ((S1 ('MetaSel ('Just "directoryType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "defaultMailDomain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeOrganizationResponse Source #

Arguments

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

Create a value of DescribeOrganizationResponse 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:DescribeOrganizationResponse', describeOrganizationResponse_directoryId - The identifier for the directory associated with an Amazon WorkMail organization.

$sel:state:DescribeOrganizationResponse', describeOrganizationResponse_state - The state of an organization.

$sel:arn:DescribeOrganizationResponse', describeOrganizationResponse_arn - The Amazon Resource Name (ARN) of the organization.

$sel:alias:DescribeOrganizationResponse', describeOrganizationResponse_alias - The alias for an organization.

$sel:completedDate:DescribeOrganizationResponse', describeOrganizationResponse_completedDate - The date at which the organization became usable in the WorkMail context, in UNIX epoch time format.

$sel:directoryType:DescribeOrganizationResponse', describeOrganizationResponse_directoryType - The type of directory associated with the WorkMail organization.

$sel:defaultMailDomain:DescribeOrganizationResponse', describeOrganizationResponse_defaultMailDomain - The default mail domain associated with the organization.

$sel:errorMessage:DescribeOrganizationResponse', describeOrganizationResponse_errorMessage - (Optional) The error message indicating if unexpected behavior was encountered with regards to the organization.

$sel:organizationId:DescribeOrganization', describeOrganizationResponse_organizationId - The identifier of an organization.

$sel:httpStatus:DescribeOrganizationResponse', describeOrganizationResponse_httpStatus - The response's http status code.

Response Lenses

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

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

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

The state of an organization.

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

The Amazon Resource Name (ARN) of the organization.

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

The alias for an organization.

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

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

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

The type of directory associated with the WorkMail organization.

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

The default mail domain associated with the organization.

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

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

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

The identifier of an organization.

describeOrganizationResponse_httpStatus :: Lens' DescribeOrganizationResponse Int Source #

The response's http status code.