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.Omics.ListRuns

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a list of runs.

This operation returns paginated results.

Synopsis

data ListRuns = ListRuns' {
- maxResults :: Maybe Natural
- name :: Maybe Text
- runGroupId :: Maybe Text
- startingToken :: Maybe Text
}
newListRuns :: ListRuns
listRuns_maxResults :: Lens' ListRuns (Maybe Natural)
listRuns_name :: Lens' ListRuns (Maybe Text)
listRuns_runGroupId :: Lens' ListRuns (Maybe Text)
listRuns_startingToken :: Lens' ListRuns (Maybe Text)
data ListRunsResponse = ListRunsResponse' {
- items :: Maybe [RunListItem]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListRunsResponse :: Int -> ListRunsResponse
listRunsResponse_items :: Lens' ListRunsResponse (Maybe [RunListItem])
listRunsResponse_nextToken :: Lens' ListRunsResponse (Maybe Text)
listRunsResponse_httpStatus :: Lens' ListRunsResponse Int

Creating a Request

data ListRuns Source #

See: newListRuns smart constructor.

Constructors

ListRuns'
Fields maxResults :: Maybe Natural The maximum number of runs to return in one page of results. name :: Maybe Text Filter the list by run name. runGroupId :: Maybe Text Filter the list by run group ID. startingToken :: Maybe Text Specify the pagination token from a previous request to retrieve the next page of results.

Instances

Instances details

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

newListRuns :: ListRuns Source #

Create a value of ListRuns 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:ListRuns', listRuns_maxResults - The maximum number of runs to return in one page of results.

ListRuns, listRuns_name - Filter the list by run name.

$sel:runGroupId:ListRuns', listRuns_runGroupId - Filter the list by run group ID.

$sel:startingToken:ListRuns', listRuns_startingToken - Specify the pagination token from a previous request to retrieve the next page of results.

Request Lenses

listRuns_maxResults :: Lens' ListRuns (Maybe Natural) Source #

The maximum number of runs to return in one page of results.

listRuns_name :: Lens' ListRuns (Maybe Text) Source #

Filter the list by run name.

listRuns_runGroupId :: Lens' ListRuns (Maybe Text) Source #

Filter the list by run group ID.

listRuns_startingToken :: Lens' ListRuns (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

Destructuring the Response

data ListRunsResponse Source #

See: newListRunsResponse smart constructor.

Constructors

ListRunsResponse'
Fields items :: Maybe [RunListItem] A list of runs. nextToken :: Maybe Text A pagination token that's included if more results are available. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListRunsResponse Source #

Arguments

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

Create a value of ListRunsResponse 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:items:ListRunsResponse', listRunsResponse_items - A list of runs.

$sel:nextToken:ListRunsResponse', listRunsResponse_nextToken - A pagination token that's included if more results are available.

$sel:httpStatus:ListRunsResponse', listRunsResponse_httpStatus - The response's http status code.

Response Lenses

listRunsResponse_items :: Lens' ListRunsResponse (Maybe [RunListItem]) Source #

A list of runs.

listRunsResponse_nextToken :: Lens' ListRunsResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

listRunsResponse_httpStatus :: Lens' ListRunsResponse Int Source #

The response's http status code.