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

Amazonka.WorkMail.TestAvailabilityConfiguration

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Synopsis

Creating a Request

data TestAvailabilityConfiguration Source #

See: newTestAvailabilityConfiguration smart constructor.

Constructors

TestAvailabilityConfiguration'
Fields domainName :: Maybe Text 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 :: Maybe EwsAvailabilityProvider lambdaProvider :: Maybe LambdaAvailabilityProvider organizationId :: Text The WorkMail organization where the availability provider will be tested.

Instances

Instances details

ToJSON TestAvailabilityConfiguration Source #
Instance details Defined in Amazonka.WorkMail.TestAvailabilityConfiguration Methods toJSON :: TestAvailabilityConfiguration -> Value # toEncoding :: TestAvailabilityConfiguration -> Encoding # toJSONList :: [TestAvailabilityConfiguration] -> Value # toEncodingList :: [TestAvailabilityConfiguration] -> Encoding #
ToHeaders TestAvailabilityConfiguration Source #
Instance details Defined in Amazonka.WorkMail.TestAvailabilityConfiguration Methods toHeaders :: TestAvailabilityConfiguration -> [Header] #
ToPath TestAvailabilityConfiguration Source #
Instance details Defined in Amazonka.WorkMail.TestAvailabilityConfiguration Methods toPath :: TestAvailabilityConfiguration -> ByteString #
ToQuery TestAvailabilityConfiguration Source #
Instance details Defined in Amazonka.WorkMail.TestAvailabilityConfiguration Methods toQuery :: TestAvailabilityConfiguration -> QueryString #
AWSRequest TestAvailabilityConfiguration Source #
Instance details Defined in Amazonka.WorkMail.TestAvailabilityConfiguration Associated Types type AWSResponse TestAvailabilityConfiguration # Methods request :: (Service -> Service) -> TestAvailabilityConfiguration -> Request TestAvailabilityConfiguration # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy TestAvailabilityConfiguration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse TestAvailabilityConfiguration))) #
Generic TestAvailabilityConfiguration Source #
Instance details Defined in Amazonka.WorkMail.TestAvailabilityConfiguration Associated Types type Rep TestAvailabilityConfiguration :: Type -> Type # Methods from :: TestAvailabilityConfiguration -> Rep TestAvailabilityConfiguration x # to :: Rep TestAvailabilityConfiguration x -> TestAvailabilityConfiguration #
Show TestAvailabilityConfiguration Source #
Instance details Defined in Amazonka.WorkMail.TestAvailabilityConfiguration Methods showsPrec :: Int -> TestAvailabilityConfiguration -> ShowS # show :: TestAvailabilityConfiguration -> String # showList :: [TestAvailabilityConfiguration] -> ShowS #
NFData TestAvailabilityConfiguration Source #
Instance details Defined in Amazonka.WorkMail.TestAvailabilityConfiguration Methods rnf :: TestAvailabilityConfiguration -> () #
Eq TestAvailabilityConfiguration Source #
Instance details Defined in Amazonka.WorkMail.TestAvailabilityConfiguration Methods (==) :: TestAvailabilityConfiguration -> TestAvailabilityConfiguration -> Bool # (/=) :: TestAvailabilityConfiguration -> TestAvailabilityConfiguration -> Bool #
Hashable TestAvailabilityConfiguration Source #
Instance details Defined in Amazonka.WorkMail.TestAvailabilityConfiguration Methods hashWithSalt :: Int -> TestAvailabilityConfiguration -> Int # hash :: TestAvailabilityConfiguration -> Int #
type AWSResponse TestAvailabilityConfiguration Source #
Instance details Defined in Amazonka.WorkMail.TestAvailabilityConfiguration type AWSResponse TestAvailabilityConfiguration = TestAvailabilityConfigurationResponse
type Rep TestAvailabilityConfiguration Source #
Instance details Defined in Amazonka.WorkMail.TestAvailabilityConfiguration type Rep TestAvailabilityConfiguration = D1 ('MetaData "TestAvailabilityConfiguration" "Amazonka.WorkMail.TestAvailabilityConfiguration" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "TestAvailabilityConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "ewsProvider") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EwsAvailabilityProvider))) :: (S1 ('MetaSel ('Just "lambdaProvider") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LambdaAvailabilityProvider)) :*: S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newTestAvailabilityConfiguration Source #

Arguments

:: Text	`TestAvailabilityConfiguration`
-> TestAvailabilityConfiguration

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.

Constructors

TestAvailabilityConfigurationResponse'
Fields failureReason :: Maybe Text String containing the reason for a failed test if `TestPassed` is false. testPassed :: Maybe Bool Boolean indicating whether the test passed or failed. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic TestAvailabilityConfigurationResponse Source #
Instance details Defined in Amazonka.WorkMail.TestAvailabilityConfiguration Associated Types type Rep TestAvailabilityConfigurationResponse :: Type -> Type # Methods from :: TestAvailabilityConfigurationResponse -> Rep TestAvailabilityConfigurationResponse x # to :: Rep TestAvailabilityConfigurationResponse x -> TestAvailabilityConfigurationResponse #
Read TestAvailabilityConfigurationResponse Source #
Instance details Defined in Amazonka.WorkMail.TestAvailabilityConfiguration Methods readsPrec :: Int -> ReadS TestAvailabilityConfigurationResponse # readList :: ReadS [TestAvailabilityConfigurationResponse] # readPrec :: ReadPrec TestAvailabilityConfigurationResponse # readListPrec :: ReadPrec [TestAvailabilityConfigurationResponse] #
Show TestAvailabilityConfigurationResponse Source #
Instance details Defined in Amazonka.WorkMail.TestAvailabilityConfiguration Methods showsPrec :: Int -> TestAvailabilityConfigurationResponse -> ShowS # show :: TestAvailabilityConfigurationResponse -> String # showList :: [TestAvailabilityConfigurationResponse] -> ShowS #
NFData TestAvailabilityConfigurationResponse Source #
Instance details Defined in Amazonka.WorkMail.TestAvailabilityConfiguration Methods rnf :: TestAvailabilityConfigurationResponse -> () #
Eq TestAvailabilityConfigurationResponse Source #
Instance details Defined in Amazonka.WorkMail.TestAvailabilityConfiguration Methods (==) :: TestAvailabilityConfigurationResponse -> TestAvailabilityConfigurationResponse -> Bool # (/=) :: TestAvailabilityConfigurationResponse -> TestAvailabilityConfigurationResponse -> Bool #
type Rep TestAvailabilityConfigurationResponse Source #
Instance details Defined in Amazonka.WorkMail.TestAvailabilityConfiguration type Rep TestAvailabilityConfigurationResponse = D1 ('MetaData "TestAvailabilityConfigurationResponse" "Amazonka.WorkMail.TestAvailabilityConfiguration" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "TestAvailabilityConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "testPassed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newTestAvailabilityConfigurationResponse Source #

Arguments

:: Int	`$sel:httpStatus:TestAvailabilityConfigurationResponse'`
-> TestAvailabilityConfigurationResponse

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.