Amazonka.StorageGateway.StartAvailabilityMonitorTest

Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the DescribeAvailabilityMonitorTest API.

Starting this test will cause your gateway to go offline for a brief period.

Creating a Request

data StartAvailabilityMonitorTest

See: newStartAvailabilityMonitorTest smart constructor.

Constructors

StartAvailabilityMonitorTest'

Fields

• gatewayARN :: Text

Instances

ToJSON StartAvailabilityMonitorTest

Defined in Amazonka.StorageGateway.StartAvailabilityMonitorTest

Methods

toJSON :: StartAvailabilityMonitorTest -> Value

toEncoding :: StartAvailabilityMonitorTest -> Encoding

toJSONList :: [StartAvailabilityMonitorTest] -> Value

toEncodingList :: [StartAvailabilityMonitorTest] -> Encoding

ToHeaders StartAvailabilityMonitorTest

Defined in Amazonka.StorageGateway.StartAvailabilityMonitorTest

Methods

toHeaders :: StartAvailabilityMonitorTest -> [Header]

ToPath StartAvailabilityMonitorTest

Defined in Amazonka.StorageGateway.StartAvailabilityMonitorTest

Methods

toPath :: StartAvailabilityMonitorTest -> ByteString

ToQuery StartAvailabilityMonitorTest

Defined in Amazonka.StorageGateway.StartAvailabilityMonitorTest

Methods

toQuery :: StartAvailabilityMonitorTest -> QueryString

AWSRequest StartAvailabilityMonitorTest

Defined in Amazonka.StorageGateway.StartAvailabilityMonitorTest

Associated Types

type AWSResponse StartAvailabilityMonitorTest

Methods

request :: (Service -> Service) -> StartAvailabilityMonitorTest -> Request StartAvailabilityMonitorTest

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartAvailabilityMonitorTest -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartAvailabilityMonitorTest)))

Generic StartAvailabilityMonitorTest

Defined in Amazonka.StorageGateway.StartAvailabilityMonitorTest

Associated Types

type Rep StartAvailabilityMonitorTest :: Type -> Type

Methods

from :: StartAvailabilityMonitorTest -> Rep StartAvailabilityMonitorTest x

to :: Rep StartAvailabilityMonitorTest x -> StartAvailabilityMonitorTest

Read StartAvailabilityMonitorTest

Defined in Amazonka.StorageGateway.StartAvailabilityMonitorTest

Methods

readsPrec :: Int -> ReadS StartAvailabilityMonitorTest

readList :: ReadS [StartAvailabilityMonitorTest]

readPrec :: ReadPrec StartAvailabilityMonitorTest

readListPrec :: ReadPrec [StartAvailabilityMonitorTest]

Show StartAvailabilityMonitorTest

Defined in Amazonka.StorageGateway.StartAvailabilityMonitorTest

Methods

showsPrec :: Int -> StartAvailabilityMonitorTest -> ShowS

show :: StartAvailabilityMonitorTest -> String

showList :: [StartAvailabilityMonitorTest] -> ShowS

NFData StartAvailabilityMonitorTest

Defined in Amazonka.StorageGateway.StartAvailabilityMonitorTest

Methods

rnf :: StartAvailabilityMonitorTest -> ()

Eq StartAvailabilityMonitorTest

Defined in Amazonka.StorageGateway.StartAvailabilityMonitorTest

Methods

(==) :: StartAvailabilityMonitorTest -> StartAvailabilityMonitorTest -> Bool

(/=) :: StartAvailabilityMonitorTest -> StartAvailabilityMonitorTest -> Bool

Hashable StartAvailabilityMonitorTest

Defined in Amazonka.StorageGateway.StartAvailabilityMonitorTest

Methods

hashWithSalt :: Int -> StartAvailabilityMonitorTest -> Int

hash :: StartAvailabilityMonitorTest -> Int

type AWSResponse StartAvailabilityMonitorTest

Defined in Amazonka.StorageGateway.StartAvailabilityMonitorTest

type AWSResponse StartAvailabilityMonitorTest = StartAvailabilityMonitorTestResponse

type Rep StartAvailabilityMonitorTest

Defined in Amazonka.StorageGateway.StartAvailabilityMonitorTest

type Rep StartAvailabilityMonitorTest = D1 ('MetaData "StartAvailabilityMonitorTest" "Amazonka.StorageGateway.StartAvailabilityMonitorTest" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "StartAvailabilityMonitorTest'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStartAvailabilityMonitorTest

Arguments

:: Text

StartAvailabilityMonitorTest

-> StartAvailabilityMonitorTest

Create a value of StartAvailabilityMonitorTest 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:

StartAvailabilityMonitorTest, startAvailabilityMonitorTest_gatewayARN - Undocumented member.

Request Lenses

startAvailabilityMonitorTest_gatewayARN :: Lens' StartAvailabilityMonitorTest Text

Undocumented member.

Destructuring the Response

data StartAvailabilityMonitorTestResponse

See: newStartAvailabilityMonitorTestResponse smart constructor.

Constructors

StartAvailabilityMonitorTestResponse'

Fields

• gatewayARN :: Maybe Text
• httpStatus :: Int

  The response's http status code.

Instances

Generic StartAvailabilityMonitorTestResponse

Defined in Amazonka.StorageGateway.StartAvailabilityMonitorTest

Associated Types

type Rep StartAvailabilityMonitorTestResponse :: Type -> Type

Methods

from :: StartAvailabilityMonitorTestResponse -> Rep StartAvailabilityMonitorTestResponse x

to :: Rep StartAvailabilityMonitorTestResponse x -> StartAvailabilityMonitorTestResponse

Read StartAvailabilityMonitorTestResponse

Defined in Amazonka.StorageGateway.StartAvailabilityMonitorTest

Methods

readsPrec :: Int -> ReadS StartAvailabilityMonitorTestResponse

readList :: ReadS [StartAvailabilityMonitorTestResponse]

readPrec :: ReadPrec StartAvailabilityMonitorTestResponse

readListPrec :: ReadPrec [StartAvailabilityMonitorTestResponse]

Show StartAvailabilityMonitorTestResponse

Defined in Amazonka.StorageGateway.StartAvailabilityMonitorTest

Methods

showsPrec :: Int -> StartAvailabilityMonitorTestResponse -> ShowS

show :: StartAvailabilityMonitorTestResponse -> String

showList :: [StartAvailabilityMonitorTestResponse] -> ShowS

NFData StartAvailabilityMonitorTestResponse

Defined in Amazonka.StorageGateway.StartAvailabilityMonitorTest

Methods

rnf :: StartAvailabilityMonitorTestResponse -> ()

Eq StartAvailabilityMonitorTestResponse

Defined in Amazonka.StorageGateway.StartAvailabilityMonitorTest

Methods

(==) :: StartAvailabilityMonitorTestResponse -> StartAvailabilityMonitorTestResponse -> Bool

(/=) :: StartAvailabilityMonitorTestResponse -> StartAvailabilityMonitorTestResponse -> Bool

type Rep StartAvailabilityMonitorTestResponse

Defined in Amazonka.StorageGateway.StartAvailabilityMonitorTest

type Rep StartAvailabilityMonitorTestResponse = D1 ('MetaData "StartAvailabilityMonitorTestResponse" "Amazonka.StorageGateway.StartAvailabilityMonitorTest" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "StartAvailabilityMonitorTestResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartAvailabilityMonitorTestResponse

Arguments

:: Int

$sel:httpStatus:StartAvailabilityMonitorTestResponse'

-> StartAvailabilityMonitorTestResponse

Create a value of StartAvailabilityMonitorTestResponse 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:

StartAvailabilityMonitorTest, startAvailabilityMonitorTestResponse_gatewayARN - Undocumented member.

$sel:httpStatus:StartAvailabilityMonitorTestResponse', startAvailabilityMonitorTestResponse_httpStatus - The response's http status code.

Response Lenses

startAvailabilityMonitorTestResponse_gatewayARN :: Lens' StartAvailabilityMonitorTestResponse (Maybe Text)

Undocumented member.

startAvailabilityMonitorTestResponse_httpStatus :: Lens' StartAvailabilityMonitorTestResponse Int

The response's http status code.