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.IoTDeviceAdvisor.ListSuiteRuns

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists runs of the specified Device Advisor test suite. You can list all runs of the test suite, or the runs of a specific version of the test suite.

Requires permission to access the ListSuiteRuns action.

Synopsis

data ListSuiteRuns = ListSuiteRuns' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- suiteDefinitionId :: Maybe Text
- suiteDefinitionVersion :: Maybe Text
}
newListSuiteRuns :: ListSuiteRuns
listSuiteRuns_maxResults :: Lens' ListSuiteRuns (Maybe Natural)
listSuiteRuns_nextToken :: Lens' ListSuiteRuns (Maybe Text)
listSuiteRuns_suiteDefinitionId :: Lens' ListSuiteRuns (Maybe Text)
listSuiteRuns_suiteDefinitionVersion :: Lens' ListSuiteRuns (Maybe Text)
data ListSuiteRunsResponse = ListSuiteRunsResponse' {
- nextToken :: Maybe Text
- suiteRunsList :: Maybe [SuiteRunInformation]
- httpStatus :: Int
}
newListSuiteRunsResponse :: Int -> ListSuiteRunsResponse
listSuiteRunsResponse_nextToken :: Lens' ListSuiteRunsResponse (Maybe Text)
listSuiteRunsResponse_suiteRunsList :: Lens' ListSuiteRunsResponse (Maybe [SuiteRunInformation])
listSuiteRunsResponse_httpStatus :: Lens' ListSuiteRunsResponse Int

Creating a Request

data ListSuiteRuns Source #

See: newListSuiteRuns smart constructor.

Constructors

ListSuiteRuns'

Fields

maxResults :: Maybe Natural
The maximum number of results to return at once.
nextToken :: Maybe Text
A token to retrieve the next set of results.
suiteDefinitionId :: Maybe Text
Lists the test suite runs of the specified test suite based on suite definition ID.
suiteDefinitionVersion :: Maybe Text
Must be passed along with suiteDefinitionId. Lists the test suite runs of the specified test suite based on suite definition version.

Instances

Instances details

ToHeaders ListSuiteRuns Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.ListSuiteRuns Methods toHeaders :: ListSuiteRuns -> [Header] #
ToPath ListSuiteRuns Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.ListSuiteRuns Methods toPath :: ListSuiteRuns -> ByteString #
ToQuery ListSuiteRuns Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.ListSuiteRuns Methods toQuery :: ListSuiteRuns -> QueryString #
AWSRequest ListSuiteRuns Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.ListSuiteRuns Associated Types type AWSResponse ListSuiteRuns # Methods request :: (Service -> Service) -> ListSuiteRuns -> Request ListSuiteRuns # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListSuiteRuns -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListSuiteRuns))) #
Generic ListSuiteRuns Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.ListSuiteRuns Associated Types type Rep ListSuiteRuns :: Type -> Type # Methods from :: ListSuiteRuns -> Rep ListSuiteRuns x # to :: Rep ListSuiteRuns x -> ListSuiteRuns #
Read ListSuiteRuns Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.ListSuiteRuns Methods readsPrec :: Int -> ReadS ListSuiteRuns # readList :: ReadS [ListSuiteRuns] # readPrec :: ReadPrec ListSuiteRuns # readListPrec :: ReadPrec [ListSuiteRuns] #
Show ListSuiteRuns Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.ListSuiteRuns Methods showsPrec :: Int -> ListSuiteRuns -> ShowS # show :: ListSuiteRuns -> String # showList :: [ListSuiteRuns] -> ShowS #
NFData ListSuiteRuns Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.ListSuiteRuns Methods rnf :: ListSuiteRuns -> () #
Eq ListSuiteRuns Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.ListSuiteRuns Methods (==) :: ListSuiteRuns -> ListSuiteRuns -> Bool # (/=) :: ListSuiteRuns -> ListSuiteRuns -> Bool #
Hashable ListSuiteRuns Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.ListSuiteRuns Methods hashWithSalt :: Int -> ListSuiteRuns -> Int # hash :: ListSuiteRuns -> Int #
type AWSResponse ListSuiteRuns Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.ListSuiteRuns type AWSResponse ListSuiteRuns = ListSuiteRunsResponse
type Rep ListSuiteRuns Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.ListSuiteRuns type Rep ListSuiteRuns = D1 ('MetaData "ListSuiteRuns" "Amazonka.IoTDeviceAdvisor.ListSuiteRuns" "amazonka-iotdeviceadvisor-2.0-DMTYim03jFoq2XrPgpZdL" 'False) (C1 ('MetaCons "ListSuiteRuns'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "suiteDefinitionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "suiteDefinitionVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListSuiteRuns :: ListSuiteRuns Source #

Create a value of ListSuiteRuns 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:maxResults:ListSuiteRuns', listSuiteRuns_maxResults - The maximum number of results to return at once.

ListSuiteRuns, listSuiteRuns_nextToken - A token to retrieve the next set of results.

ListSuiteRuns, listSuiteRuns_suiteDefinitionId - Lists the test suite runs of the specified test suite based on suite definition ID.

ListSuiteRuns, listSuiteRuns_suiteDefinitionVersion - Must be passed along with suiteDefinitionId. Lists the test suite runs of the specified test suite based on suite definition version.

Request Lenses

listSuiteRuns_maxResults :: Lens' ListSuiteRuns (Maybe Natural) Source #

The maximum number of results to return at once.

listSuiteRuns_nextToken :: Lens' ListSuiteRuns (Maybe Text) Source #

A token to retrieve the next set of results.

listSuiteRuns_suiteDefinitionId :: Lens' ListSuiteRuns (Maybe Text) Source #

Lists the test suite runs of the specified test suite based on suite definition ID.

listSuiteRuns_suiteDefinitionVersion :: Lens' ListSuiteRuns (Maybe Text) Source #

Must be passed along with suiteDefinitionId. Lists the test suite runs of the specified test suite based on suite definition version.

Destructuring the Response

data ListSuiteRunsResponse Source #

See: newListSuiteRunsResponse smart constructor.

Constructors

ListSuiteRunsResponse'
Fields nextToken :: Maybe Text A token to retrieve the next set of results. suiteRunsList :: Maybe [SuiteRunInformation] An array of objects that provide summaries of information about the suite runs in the list. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListSuiteRunsResponse Source #

Arguments

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

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

ListSuiteRuns, listSuiteRunsResponse_nextToken - A token to retrieve the next set of results.

$sel:suiteRunsList:ListSuiteRunsResponse', listSuiteRunsResponse_suiteRunsList - An array of objects that provide summaries of information about the suite runs in the list.

$sel:httpStatus:ListSuiteRunsResponse', listSuiteRunsResponse_httpStatus - The response's http status code.

Response Lenses

listSuiteRunsResponse_nextToken :: Lens' ListSuiteRunsResponse (Maybe Text) Source #

A token to retrieve the next set of results.

listSuiteRunsResponse_suiteRunsList :: Lens' ListSuiteRunsResponse (Maybe [SuiteRunInformation]) Source #

An array of objects that provide summaries of information about the suite runs in the list.

listSuiteRunsResponse_httpStatus :: Lens' ListSuiteRunsResponse Int Source #

The response's http status code.