[ aws . workmail ]

test-availability-configuration

Description

Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked and that the resource access policy was configured to deny anonymous access. An anonymous invocation is one done without providing either a SourceArn or SourceAccount header.

Note

The request must contain either one provider definition (EwsProvider or LambdaProvider ) or the DomainName parameter. If the DomainName parameter is provided, the configuration stored under the DomainName will be tested.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--organization-id (string)

The Amazon WorkMail organization where the availability provider will be tested.

--domain-name (string)

The domain to which the provider applies. If this field is provided, a stored availability provider associated to this domain name will be tested.

--ews-provider (structure)

Describes an EWS based availability provider. This is only used as input to the service.

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)

Describes a Lambda based availability provider.

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

TestPassed -> (boolean)

Boolean indicating whether the test passed or failed.

FailureReason -> (string)

String containing the reason for a failed test if TestPassed is false.