Amazonka.WorkMail.DescribeOrganization

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

Creating a Request

data DescribeOrganization

See: newDescribeOrganization smart constructor.

Constructors

DescribeOrganization'

Fields

• organizationId :: Text

  The identifier for the organization to be described.

Instances

ToJSON DescribeOrganization

Defined in Amazonka.WorkMail.DescribeOrganization

Methods

toJSON :: DescribeOrganization -> Value

toEncoding :: DescribeOrganization -> Encoding

toJSONList :: [DescribeOrganization] -> Value

toEncodingList :: [DescribeOrganization] -> Encoding

ToHeaders DescribeOrganization

Defined in Amazonka.WorkMail.DescribeOrganization

Methods

toHeaders :: DescribeOrganization -> [Header]

ToPath DescribeOrganization

Defined in Amazonka.WorkMail.DescribeOrganization

Methods

toPath :: DescribeOrganization -> ByteString

ToQuery DescribeOrganization

Defined in Amazonka.WorkMail.DescribeOrganization

Methods

toQuery :: DescribeOrganization -> QueryString

AWSRequest DescribeOrganization

Defined in Amazonka.WorkMail.DescribeOrganization

Associated Types

type AWSResponse DescribeOrganization

Methods

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

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

Generic DescribeOrganization

Defined in Amazonka.WorkMail.DescribeOrganization

Associated Types

type Rep DescribeOrganization :: Type -> Type

Methods

from :: DescribeOrganization -> Rep DescribeOrganization x

to :: Rep DescribeOrganization x -> DescribeOrganization

Read DescribeOrganization

Defined in Amazonka.WorkMail.DescribeOrganization

Methods

readsPrec :: Int -> ReadS DescribeOrganization

readList :: ReadS [DescribeOrganization]

readPrec :: ReadPrec DescribeOrganization

readListPrec :: ReadPrec [DescribeOrganization]

Show DescribeOrganization

Defined in Amazonka.WorkMail.DescribeOrganization

Methods

showsPrec :: Int -> DescribeOrganization -> ShowS

show :: DescribeOrganization -> String

showList :: [DescribeOrganization] -> ShowS

NFData DescribeOrganization

Defined in Amazonka.WorkMail.DescribeOrganization

Methods

rnf :: DescribeOrganization -> ()

Eq DescribeOrganization

Defined in Amazonka.WorkMail.DescribeOrganization

Methods

(==) :: DescribeOrganization -> DescribeOrganization -> Bool

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

Hashable DescribeOrganization

Defined in Amazonka.WorkMail.DescribeOrganization

Methods

hashWithSalt :: Int -> DescribeOrganization -> Int

hash :: DescribeOrganization -> Int

type AWSResponse DescribeOrganization

Defined in Amazonka.WorkMail.DescribeOrganization

type AWSResponse DescribeOrganization = DescribeOrganizationResponse

type Rep DescribeOrganization

Defined in Amazonka.WorkMail.DescribeOrganization

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

newDescribeOrganization

Arguments

:: Text

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:

DescribeOrganization, describeOrganization_organizationId - The identifier for the organization to be described.

Request Lenses

describeOrganization_organizationId :: Lens' DescribeOrganization Text

The identifier for the organization to be described.

Destructuring the Response

data DescribeOrganizationResponse

See: newDescribeOrganizationResponse smart constructor.

Constructors

DescribeOrganizationResponse'

Fields

• 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.

• defaultMailDomain :: Maybe Text

  The default mail domain associated with the organization.

• directoryId :: Maybe Text

  The identifier for the directory associated with an WorkMail organization.

• directoryType :: Maybe Text

  The type of directory associated with the WorkMail 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.

• state :: Maybe Text

  The state of an organization.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeOrganizationResponse

Defined in Amazonka.WorkMail.DescribeOrganization

Associated Types

type Rep DescribeOrganizationResponse :: Type -> Type

Methods

from :: DescribeOrganizationResponse -> Rep DescribeOrganizationResponse x

to :: Rep DescribeOrganizationResponse x -> DescribeOrganizationResponse

Read DescribeOrganizationResponse

Defined in Amazonka.WorkMail.DescribeOrganization

Methods

readsPrec :: Int -> ReadS DescribeOrganizationResponse

readList :: ReadS [DescribeOrganizationResponse]

readPrec :: ReadPrec DescribeOrganizationResponse

readListPrec :: ReadPrec [DescribeOrganizationResponse]

Show DescribeOrganizationResponse

Defined in Amazonka.WorkMail.DescribeOrganization

Methods

showsPrec :: Int -> DescribeOrganizationResponse -> ShowS

show :: DescribeOrganizationResponse -> String

showList :: [DescribeOrganizationResponse] -> ShowS

NFData DescribeOrganizationResponse

Defined in Amazonka.WorkMail.DescribeOrganization

Methods

rnf :: DescribeOrganizationResponse -> ()

Eq DescribeOrganizationResponse

Defined in Amazonka.WorkMail.DescribeOrganization

Methods

(==) :: DescribeOrganizationResponse -> DescribeOrganizationResponse -> Bool

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

type Rep DescribeOrganizationResponse

Defined in Amazonka.WorkMail.DescribeOrganization

type Rep DescribeOrganizationResponse = D1 ('MetaData "DescribeOrganizationResponse" "Amazonka.WorkMail.DescribeOrganization" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "DescribeOrganizationResponse'" 'PrefixI 'True) (((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 "defaultMailDomain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "directoryType") '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 "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeOrganizationResponse

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:arn:DescribeOrganizationResponse', describeOrganizationResponse_arn - The Amazon Resource Name (ARN) of the organization.

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.

DescribeOrganizationResponse, describeOrganizationResponse_defaultMailDomain - The default mail domain associated with the organization.

$sel:directoryId:DescribeOrganizationResponse', describeOrganizationResponse_directoryId - The identifier for the directory associated with an WorkMail organization.

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

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

DescribeOrganization, describeOrganizationResponse_organizationId - The identifier of an organization.

DescribeOrganizationResponse, describeOrganizationResponse_state - The state of an organization.

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

Response Lenses

describeOrganizationResponse_arn :: Lens' DescribeOrganizationResponse (Maybe Text)

The Amazon Resource Name (ARN) of the organization.

describeOrganizationResponse_alias :: Lens' DescribeOrganizationResponse (Maybe Text)

The alias for an organization.

describeOrganizationResponse_completedDate :: Lens' DescribeOrganizationResponse (Maybe UTCTime)

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

describeOrganizationResponse_defaultMailDomain :: Lens' DescribeOrganizationResponse (Maybe Text)

The default mail domain associated with the organization.

describeOrganizationResponse_directoryId :: Lens' DescribeOrganizationResponse (Maybe Text)

The identifier for the directory associated with an WorkMail organization.

describeOrganizationResponse_directoryType :: Lens' DescribeOrganizationResponse (Maybe Text)

The type of directory associated with the WorkMail organization.

describeOrganizationResponse_errorMessage :: Lens' DescribeOrganizationResponse (Maybe Text)

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

describeOrganizationResponse_organizationId :: Lens' DescribeOrganizationResponse (Maybe Text)

The identifier of an organization.

describeOrganizationResponse_state :: Lens' DescribeOrganizationResponse (Maybe Text)

The state of an organization.

describeOrganizationResponse_httpStatus :: Lens' DescribeOrganizationResponse Int

The response's http status code.