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.ListReferences

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a list of references.

This operation returns paginated results.

Synopsis

data ListReferences = ListReferences' {
- filter' :: Maybe ReferenceFilter
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- referenceStoreId :: Text
}
newListReferences :: Text -> ListReferences
listReferences_filter :: Lens' ListReferences (Maybe ReferenceFilter)
listReferences_maxResults :: Lens' ListReferences (Maybe Natural)
listReferences_nextToken :: Lens' ListReferences (Maybe Text)
listReferences_referenceStoreId :: Lens' ListReferences Text
data ListReferencesResponse = ListReferencesResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- references :: [ReferenceListItem]
}
newListReferencesResponse :: Int -> ListReferencesResponse
listReferencesResponse_nextToken :: Lens' ListReferencesResponse (Maybe Text)
listReferencesResponse_httpStatus :: Lens' ListReferencesResponse Int
listReferencesResponse_references :: Lens' ListReferencesResponse [ReferenceListItem]

Creating a Request

data ListReferences Source #

See: newListReferences smart constructor.

Constructors

ListReferences'
Fields filter' :: Maybe ReferenceFilter A filter to apply to the list. maxResults :: Maybe Natural The maximum number of references to return in one page of results. nextToken :: Maybe Text Specify the pagination token from a previous request to retrieve the next page of results. referenceStoreId :: Text The references' reference store ID.

Instances

Instances details

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

newListReferences Source #

Arguments

:: Text	`ListReferences`
-> ListReferences

Create a value of ListReferences 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:filter':ListReferences', listReferences_filter - A filter to apply to the list.

$sel:maxResults:ListReferences', listReferences_maxResults - The maximum number of references to return in one page of results.

ListReferences, listReferences_nextToken - Specify the pagination token from a previous request to retrieve the next page of results.

ListReferences, listReferences_referenceStoreId - The references' reference store ID.

Request Lenses

listReferences_filter :: Lens' ListReferences (Maybe ReferenceFilter) Source #

A filter to apply to the list.

listReferences_maxResults :: Lens' ListReferences (Maybe Natural) Source #

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

listReferences_nextToken :: Lens' ListReferences (Maybe Text) Source #

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

listReferences_referenceStoreId :: Lens' ListReferences Text Source #

The references' reference store ID.

Destructuring the Response

data ListReferencesResponse Source #

See: newListReferencesResponse smart constructor.

Constructors

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

Instances

Instances details

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

newListReferencesResponse Source #

Arguments

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

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

ListReferences, listReferencesResponse_nextToken - A pagination token that's included if more results are available.

$sel:httpStatus:ListReferencesResponse', listReferencesResponse_httpStatus - The response's http status code.

$sel:references:ListReferencesResponse', listReferencesResponse_references - A list of references.

Response Lenses

listReferencesResponse_nextToken :: Lens' ListReferencesResponse (Maybe Text) Source #

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

listReferencesResponse_httpStatus :: Lens' ListReferencesResponse Int Source #

The response's http status code.

listReferencesResponse_references :: Lens' ListReferencesResponse [ReferenceListItem] Source #

A list of references.