Test Availability Configuration

workmail_test_availability_configuration

R Documentation

Performs a test on an availability provider to ensure that access is allowed¶

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.

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.

Usage¶

workmail_test_availability_configuration(OrganizationId, DomainName,
  EwsProvider, LambdaProvider)

Arguments¶

OrganizationId: [required] The WorkMail organization where the availability provider will be tested.
DomainName: The domain to which the provider applies. If this field is provided, a stored availability provider associated to this domain name will be tested.
EwsProvider
LambdaProvider

Value¶

A list with the following syntax:

list(
  TestPassed = TRUE|FALSE,
  FailureReason = "string"
)

Request syntax¶

svc$test_availability_configuration(
  OrganizationId = "string",
  DomainName = "string",
  EwsProvider = list(
    EwsEndpoint = "string",
    EwsUsername = "string",
    EwsPassword = "string"
  ),
  LambdaProvider = list(
    LambdaArn = "string"
  )
)