Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- data TestAvailabilityConfiguration = TestAvailabilityConfiguration' {}
- newTestAvailabilityConfiguration :: Text -> TestAvailabilityConfiguration
- testAvailabilityConfiguration_domainName :: Lens' TestAvailabilityConfiguration (Maybe Text)
- testAvailabilityConfiguration_ewsProvider :: Lens' TestAvailabilityConfiguration (Maybe EwsAvailabilityProvider)
- testAvailabilityConfiguration_lambdaProvider :: Lens' TestAvailabilityConfiguration (Maybe LambdaAvailabilityProvider)
- testAvailabilityConfiguration_organizationId :: Lens' TestAvailabilityConfiguration Text
- data TestAvailabilityConfigurationResponse = TestAvailabilityConfigurationResponse' {
- failureReason :: Maybe Text
- testPassed :: Maybe Bool
- httpStatus :: Int
- newTestAvailabilityConfigurationResponse :: Int -> TestAvailabilityConfigurationResponse
- testAvailabilityConfigurationResponse_failureReason :: Lens' TestAvailabilityConfigurationResponse (Maybe Text)
- testAvailabilityConfigurationResponse_testPassed :: Lens' TestAvailabilityConfigurationResponse (Maybe Bool)
- testAvailabilityConfigurationResponse_httpStatus :: Lens' TestAvailabilityConfigurationResponse Int
Creating a Request
data TestAvailabilityConfiguration Source #
See: newTestAvailabilityConfiguration
smart constructor.
TestAvailabilityConfiguration' | |
|
Instances
newTestAvailabilityConfiguration Source #
Create a value of TestAvailabilityConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
TestAvailabilityConfiguration
, testAvailabilityConfiguration_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.
TestAvailabilityConfiguration
, testAvailabilityConfiguration_ewsProvider
- Undocumented member.
TestAvailabilityConfiguration
, testAvailabilityConfiguration_lambdaProvider
- Undocumented member.
TestAvailabilityConfiguration
, testAvailabilityConfiguration_organizationId
- The WorkMail organization where the availability provider will be
tested.
Request Lenses
testAvailabilityConfiguration_domainName :: Lens' TestAvailabilityConfiguration (Maybe Text) Source #
The domain to which the provider applies. If this field is provided, a stored availability provider associated to this domain name will be tested.
testAvailabilityConfiguration_ewsProvider :: Lens' TestAvailabilityConfiguration (Maybe EwsAvailabilityProvider) Source #
Undocumented member.
testAvailabilityConfiguration_lambdaProvider :: Lens' TestAvailabilityConfiguration (Maybe LambdaAvailabilityProvider) Source #
Undocumented member.
testAvailabilityConfiguration_organizationId :: Lens' TestAvailabilityConfiguration Text Source #
The WorkMail organization where the availability provider will be tested.
Destructuring the Response
data TestAvailabilityConfigurationResponse Source #
See: newTestAvailabilityConfigurationResponse
smart constructor.
TestAvailabilityConfigurationResponse' | |
|
Instances
newTestAvailabilityConfigurationResponse Source #
Create a value of TestAvailabilityConfigurationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureReason:TestAvailabilityConfigurationResponse'
, testAvailabilityConfigurationResponse_failureReason
- String containing the reason for a failed test if TestPassed
is false.
$sel:testPassed:TestAvailabilityConfigurationResponse'
, testAvailabilityConfigurationResponse_testPassed
- Boolean indicating whether the test passed or failed.
$sel:httpStatus:TestAvailabilityConfigurationResponse'
, testAvailabilityConfigurationResponse_httpStatus
- The response's http status code.
Response Lenses
testAvailabilityConfigurationResponse_failureReason :: Lens' TestAvailabilityConfigurationResponse (Maybe Text) Source #
String containing the reason for a failed test if TestPassed
is false.
testAvailabilityConfigurationResponse_testPassed :: Lens' TestAvailabilityConfigurationResponse (Maybe Bool) Source #
Boolean indicating whether the test passed or failed.
testAvailabilityConfigurationResponse_httpStatus :: Lens' TestAvailabilityConfigurationResponse Int Source #
The response's http status code.