[ aws . workmail ]

create-availability-configuration

Description

Creates an AvailabilityConfiguration for the given WorkMail organization and domain.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-availability-configuration
[--client-token <value>]
--organization-id <value>
--domain-name <value>
[--ews-provider <value>]
[--lambda-provider <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--client-token (string)

An idempotent token that ensures that an API request is executed only once.

--organization-id (string)

The Amazon WorkMail organization for which the AvailabilityConfiguration will be created.

--domain-name (string)

The domain to which the provider applies.

--ews-provider (structure)

Exchange Web Services (EWS) availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider .

EwsEndpoint -> (string)

The endpoint of the remote EWS server.

EwsUsername -> (string)

The username used to authenticate the remote EWS server.

EwsPassword -> (string)

The password used to authenticate the remote EWS server.

Shorthand Syntax:

EwsEndpoint=string,EwsUsername=string,EwsPassword=string

JSON Syntax:

{
  "EwsEndpoint": "string",
  "EwsUsername": "string",
  "EwsPassword": "string"
}

--lambda-provider (structure)

Lambda availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider .

LambdaArn -> (string)

The Amazon Resource Name (ARN) of the Lambda that acts as the availability provider.

Shorthand Syntax:

LambdaArn=string

JSON Syntax:

{
  "LambdaArn": "string"
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

None