ListAvailabilityConfigurationsCommand

Suggest an Edit

List all the AvailabilityConfiguration's for the given WorkMail organization.

Example Syntax

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

import { WorkMailClient, ListAvailabilityConfigurationsCommand } from "@aws-sdk/client-workmail"; // ES Modules import
// const { WorkMailClient, ListAvailabilityConfigurationsCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
const client = new WorkMailClient(config);
const input = { // ListAvailabilityConfigurationsRequest
  OrganizationId: "STRING_VALUE", // required
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new ListAvailabilityConfigurationsCommand(input);
const response = await client.send(command);
// { // ListAvailabilityConfigurationsResponse
//   AvailabilityConfigurations: [ // AvailabilityConfigurationList
//     { // AvailabilityConfiguration
//       DomainName: "STRING_VALUE",
//       ProviderType: "EWS" || "LAMBDA",
//       EwsProvider: { // RedactedEwsAvailabilityProvider
//         EwsEndpoint: "STRING_VALUE",
//         EwsUsername: "STRING_VALUE",
//       },
//       LambdaProvider: { // LambdaAvailabilityProvider
//         LambdaArn: "STRING_VALUE", // required
//       },
//       DateCreated: new Date("TIMESTAMP"),
//       DateModified: new Date("TIMESTAMP"),
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListAvailabilityConfigurationsCommand Input

See ListAvailabilityConfigurationsCommandInput for more details

Parameter
Type
Description
OrganizationId
Required
string | undefined

The WorkMail organization for which the AvailabilityConfiguration's will be listed.

MaxResults
number | undefined

The maximum number of results to return in a single call.

NextToken
string | undefined

The token to use to retrieve the next page of results. The first call does not require a token.

ListAvailabilityConfigurationsCommand Output

See ListAvailabilityConfigurationsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
AvailabilityConfigurations
AvailabilityConfiguration[] | undefined

The list of AvailabilityConfiguration's that exist for the specified WorkMail organization.

NextToken
string | undefined

The token to use to retrieve the next page of results. The value is null when there are no further results to return.

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.

OrganizationStateException
client

The organization must have a valid state to perform certain operations on the organization or its members.

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