DescribeOrganizationCommand

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WorkMailClient, DescribeOrganizationCommand } from "@aws-sdk/client-workmail"; // ES Modules import
// const { WorkMailClient, DescribeOrganizationCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
const client = new WorkMailClient(config);
const input = { // DescribeOrganizationRequest
  OrganizationId: "STRING_VALUE", // required
};
const command = new DescribeOrganizationCommand(input);
const response = await client.send(command);
// { // DescribeOrganizationResponse
//   OrganizationId: "STRING_VALUE",
//   Alias: "STRING_VALUE",
//   State: "STRING_VALUE",
//   DirectoryId: "STRING_VALUE",
//   DirectoryType: "STRING_VALUE",
//   DefaultMailDomain: "STRING_VALUE",
//   CompletedDate: new Date("TIMESTAMP"),
//   ErrorMessage: "STRING_VALUE",
//   ARN: "STRING_VALUE",
//   MigrationAdmin: "STRING_VALUE",
//   InteroperabilityEnabled: true || false,
// };

DescribeOrganizationCommand Input

Parameter
Type
Description
OrganizationId
Required
string | undefined

The identifier for the organization to be described.

DescribeOrganizationCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ARN
string | undefined

The Amazon Resource Name (ARN) of the organization.

Alias
string | undefined

The alias for an organization.

CompletedDate
Date | undefined

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

DefaultMailDomain
string | undefined

The default mail domain associated with the organization.

DirectoryId
string | undefined

The identifier for the directory associated with an WorkMail organization.

DirectoryType
string | undefined

The type of directory associated with the WorkMail organization.

ErrorMessage
string | undefined

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

InteroperabilityEnabled
boolean | undefined

Indicates if interoperability is enabled for this organization.

MigrationAdmin
string | undefined

The user ID of the migration admin if migration is enabled for the organization.

OrganizationId
string | undefined

The identifier of an organization.

State
string | undefined

The state of an organization.

Throws

Name
Fault
Details
InvalidParameterException
client

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException
client

An operation received a valid organization identifier that either doesn't belong or exist in the system.

WorkMailServiceException
Base exception class for all service exceptions from WorkMail service.