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.DeviceFarm.ScheduleRun

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Schedules a run.

Synopsis

data ScheduleRun = ScheduleRun' {
- appArn :: Maybe Text
- configuration :: Maybe ScheduleRunConfiguration
- devicePoolArn :: Maybe Text
- deviceSelectionConfiguration :: Maybe DeviceSelectionConfiguration
- executionConfiguration :: Maybe ExecutionConfiguration
- name :: Maybe Text
- projectArn :: Text
- test :: ScheduleRunTest
}
newScheduleRun :: Text -> ScheduleRunTest -> ScheduleRun
scheduleRun_appArn :: Lens' ScheduleRun (Maybe Text)
scheduleRun_configuration :: Lens' ScheduleRun (Maybe ScheduleRunConfiguration)
scheduleRun_devicePoolArn :: Lens' ScheduleRun (Maybe Text)
scheduleRun_deviceSelectionConfiguration :: Lens' ScheduleRun (Maybe DeviceSelectionConfiguration)
scheduleRun_executionConfiguration :: Lens' ScheduleRun (Maybe ExecutionConfiguration)
scheduleRun_name :: Lens' ScheduleRun (Maybe Text)
scheduleRun_projectArn :: Lens' ScheduleRun Text
scheduleRun_test :: Lens' ScheduleRun ScheduleRunTest
data ScheduleRunResponse = ScheduleRunResponse' {
- run :: Maybe Run
- httpStatus :: Int
}
newScheduleRunResponse :: Int -> ScheduleRunResponse
scheduleRunResponse_run :: Lens' ScheduleRunResponse (Maybe Run)
scheduleRunResponse_httpStatus :: Lens' ScheduleRunResponse Int

Creating a Request

data ScheduleRun Source #

Represents a request to the schedule run operation.

See: newScheduleRun smart constructor.

Constructors

ScheduleRun'

Fields

appArn :: Maybe Text
The ARN of an application package to run tests against, created with CreateUpload. See ListUploads.
configuration :: Maybe ScheduleRunConfiguration
Information about the settings for the run to be scheduled.
devicePoolArn :: Maybe Text
The ARN of the device pool for the run to be scheduled.
deviceSelectionConfiguration :: Maybe DeviceSelectionConfiguration
The filter criteria used to dynamically select a set of devices for a test run and the maximum number of devices to be included in the run.
Either devicePoolArn or deviceSelectionConfiguration is required in a request.
executionConfiguration :: Maybe ExecutionConfiguration
Specifies configuration information about a test run, such as the execution timeout (in minutes).
name :: Maybe Text
The name for the run to be scheduled.
projectArn :: Text
The ARN of the project for the run to be scheduled.
test :: ScheduleRunTest
Information about the test for the run to be scheduled.

Instances

Instances details

ToJSON ScheduleRun Source #
Instance details Defined in Amazonka.DeviceFarm.ScheduleRun Methods toJSON :: ScheduleRun -> Value # toEncoding :: ScheduleRun -> Encoding # toJSONList :: [ScheduleRun] -> Value # toEncodingList :: [ScheduleRun] -> Encoding #
ToHeaders ScheduleRun Source #
Instance details Defined in Amazonka.DeviceFarm.ScheduleRun Methods toHeaders :: ScheduleRun -> [Header] #
ToPath ScheduleRun Source #
Instance details Defined in Amazonka.DeviceFarm.ScheduleRun Methods toPath :: ScheduleRun -> ByteString #
ToQuery ScheduleRun Source #
Instance details Defined in Amazonka.DeviceFarm.ScheduleRun Methods toQuery :: ScheduleRun -> QueryString #
AWSRequest ScheduleRun Source #
Instance details Defined in Amazonka.DeviceFarm.ScheduleRun Associated Types type AWSResponse ScheduleRun # Methods request :: (Service -> Service) -> ScheduleRun -> Request ScheduleRun # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ScheduleRun -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ScheduleRun))) #
Generic ScheduleRun Source #
Instance details Defined in Amazonka.DeviceFarm.ScheduleRun Associated Types type Rep ScheduleRun :: Type -> Type # Methods from :: ScheduleRun -> Rep ScheduleRun x # to :: Rep ScheduleRun x -> ScheduleRun #
Read ScheduleRun Source #
Instance details Defined in Amazonka.DeviceFarm.ScheduleRun Methods readsPrec :: Int -> ReadS ScheduleRun # readList :: ReadS [ScheduleRun] # readPrec :: ReadPrec ScheduleRun # readListPrec :: ReadPrec [ScheduleRun] #
Show ScheduleRun Source #
Instance details Defined in Amazonka.DeviceFarm.ScheduleRun Methods showsPrec :: Int -> ScheduleRun -> ShowS # show :: ScheduleRun -> String # showList :: [ScheduleRun] -> ShowS #
NFData ScheduleRun Source #
Instance details Defined in Amazonka.DeviceFarm.ScheduleRun Methods rnf :: ScheduleRun -> () #
Eq ScheduleRun Source #
Instance details Defined in Amazonka.DeviceFarm.ScheduleRun Methods (==) :: ScheduleRun -> ScheduleRun -> Bool # (/=) :: ScheduleRun -> ScheduleRun -> Bool #
Hashable ScheduleRun Source #
Instance details Defined in Amazonka.DeviceFarm.ScheduleRun Methods hashWithSalt :: Int -> ScheduleRun -> Int # hash :: ScheduleRun -> Int #
type AWSResponse ScheduleRun Source #
Instance details Defined in Amazonka.DeviceFarm.ScheduleRun type AWSResponse ScheduleRun = ScheduleRunResponse
type Rep ScheduleRun Source #
Instance details Defined in Amazonka.DeviceFarm.ScheduleRun type Rep ScheduleRun = D1 ('MetaData "ScheduleRun" "Amazonka.DeviceFarm.ScheduleRun" "amazonka-devicefarm-2.0-2e4KvZvQ9bT8TNjEPvmW9Q" 'False) (C1 ('MetaCons "ScheduleRun'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "appArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScheduleRunConfiguration))) :: (S1 ('MetaSel ('Just "devicePoolArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "deviceSelectionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeviceSelectionConfiguration)))) :: ((S1 ('MetaSel ('Just "executionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionConfiguration)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "projectArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "test") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ScheduleRunTest)))))

newScheduleRun Source #

Arguments

:: Text	`$sel:projectArn:ScheduleRun'`
-> ScheduleRunTest	`ScheduleRun`
-> ScheduleRun

Create a value of ScheduleRun 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:appArn:ScheduleRun', scheduleRun_appArn - The ARN of an application package to run tests against, created with CreateUpload. See ListUploads.

$sel:configuration:ScheduleRun', scheduleRun_configuration - Information about the settings for the run to be scheduled.

ScheduleRun, scheduleRun_devicePoolArn - The ARN of the device pool for the run to be scheduled.

$sel:deviceSelectionConfiguration:ScheduleRun', scheduleRun_deviceSelectionConfiguration - The filter criteria used to dynamically select a set of devices for a test run and the maximum number of devices to be included in the run.

Either devicePoolArn or deviceSelectionConfiguration is required in a request.

$sel:executionConfiguration:ScheduleRun', scheduleRun_executionConfiguration - Specifies configuration information about a test run, such as the execution timeout (in minutes).

ScheduleRun, scheduleRun_name - The name for the run to be scheduled.

$sel:projectArn:ScheduleRun', scheduleRun_projectArn - The ARN of the project for the run to be scheduled.

ScheduleRun, scheduleRun_test - Information about the test for the run to be scheduled.

Request Lenses

scheduleRun_appArn :: Lens' ScheduleRun (Maybe Text) Source #

The ARN of an application package to run tests against, created with CreateUpload. See ListUploads.

scheduleRun_configuration :: Lens' ScheduleRun (Maybe ScheduleRunConfiguration) Source #

Information about the settings for the run to be scheduled.

scheduleRun_devicePoolArn :: Lens' ScheduleRun (Maybe Text) Source #

The ARN of the device pool for the run to be scheduled.

scheduleRun_deviceSelectionConfiguration :: Lens' ScheduleRun (Maybe DeviceSelectionConfiguration) Source #

The filter criteria used to dynamically select a set of devices for a test run and the maximum number of devices to be included in the run.

Either devicePoolArn or deviceSelectionConfiguration is required in a request.

scheduleRun_executionConfiguration :: Lens' ScheduleRun (Maybe ExecutionConfiguration) Source #

Specifies configuration information about a test run, such as the execution timeout (in minutes).

scheduleRun_name :: Lens' ScheduleRun (Maybe Text) Source #

The name for the run to be scheduled.

scheduleRun_projectArn :: Lens' ScheduleRun Text Source #

The ARN of the project for the run to be scheduled.

scheduleRun_test :: Lens' ScheduleRun ScheduleRunTest Source #

Information about the test for the run to be scheduled.

Destructuring the Response

data ScheduleRunResponse Source #

Represents the result of a schedule run request.

See: newScheduleRunResponse smart constructor.

Constructors

ScheduleRunResponse'
Fields run :: Maybe Run Information about the scheduled run. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ScheduleRunResponse Source #
Instance details Defined in Amazonka.DeviceFarm.ScheduleRun Associated Types type Rep ScheduleRunResponse :: Type -> Type # Methods from :: ScheduleRunResponse -> Rep ScheduleRunResponse x # to :: Rep ScheduleRunResponse x -> ScheduleRunResponse #
Read ScheduleRunResponse Source #
Instance details Defined in Amazonka.DeviceFarm.ScheduleRun Methods readsPrec :: Int -> ReadS ScheduleRunResponse # readList :: ReadS [ScheduleRunResponse] # readPrec :: ReadPrec ScheduleRunResponse # readListPrec :: ReadPrec [ScheduleRunResponse] #
Show ScheduleRunResponse Source #
Instance details Defined in Amazonka.DeviceFarm.ScheduleRun Methods showsPrec :: Int -> ScheduleRunResponse -> ShowS # show :: ScheduleRunResponse -> String # showList :: [ScheduleRunResponse] -> ShowS #
NFData ScheduleRunResponse Source #
Instance details Defined in Amazonka.DeviceFarm.ScheduleRun Methods rnf :: ScheduleRunResponse -> () #
Eq ScheduleRunResponse Source #
Instance details Defined in Amazonka.DeviceFarm.ScheduleRun Methods (==) :: ScheduleRunResponse -> ScheduleRunResponse -> Bool # (/=) :: ScheduleRunResponse -> ScheduleRunResponse -> Bool #
type Rep ScheduleRunResponse Source #
Instance details Defined in Amazonka.DeviceFarm.ScheduleRun type Rep ScheduleRunResponse = D1 ('MetaData "ScheduleRunResponse" "Amazonka.DeviceFarm.ScheduleRun" "amazonka-devicefarm-2.0-2e4KvZvQ9bT8TNjEPvmW9Q" 'False) (C1 ('MetaCons "ScheduleRunResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "run") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Run)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newScheduleRunResponse Source #

Arguments

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

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

ScheduleRunResponse, scheduleRunResponse_run - Information about the scheduled run.

$sel:httpStatus:ScheduleRunResponse', scheduleRunResponse_httpStatus - The response's http status code.

Response Lenses

scheduleRunResponse_run :: Lens' ScheduleRunResponse (Maybe Run) Source #

Information about the scheduled run.

scheduleRunResponse_httpStatus :: Lens' ScheduleRunResponse Int Source #

The response's http status code.