- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateAvailabilityConfigurationCommand
Creates an AvailabilityConfiguration
for the given WorkMail organization and domain.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { WorkMailClient, CreateAvailabilityConfigurationCommand } from "@aws-sdk/client-workmail"; // ES Modules import
// const { WorkMailClient, CreateAvailabilityConfigurationCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
const client = new WorkMailClient(config);
const input = { // CreateAvailabilityConfigurationRequest
ClientToken: "STRING_VALUE",
OrganizationId: "STRING_VALUE", // required
DomainName: "STRING_VALUE", // required
EwsProvider: { // EwsAvailabilityProvider
EwsEndpoint: "STRING_VALUE", // required
EwsUsername: "STRING_VALUE", // required
EwsPassword: "STRING_VALUE", // required
},
LambdaProvider: { // LambdaAvailabilityProvider
LambdaArn: "STRING_VALUE", // required
},
};
const command = new CreateAvailabilityConfigurationCommand(input);
const response = await client.send(command);
// {};
CreateAvailabilityConfigurationCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
DomainName Required | string | undefined | The domain to which the provider applies. |
OrganizationId Required | string | undefined | The WorkMail organization for which the |
ClientToken | string | undefined | An idempotent token that ensures that an API request is executed only once. |
EwsProvider | EwsAvailabilityProvider | undefined | Exchange Web Services (EWS) availability provider definition. The request must contain exactly one provider definition, either |
LambdaProvider | LambdaAvailabilityProvider | undefined | Lambda availability provider definition. The request must contain exactly one provider definition, either |
CreateAvailabilityConfigurationCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
InvalidParameterException | client | One or more of the input parameters don't match the service's restrictions. |
LimitExceededException | client | The request exceeds the limit of the resource. |
NameAvailabilityException | client | The user, group, or resource name isn't unique in WorkMail. |
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. |