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.MGN.ListWaves

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves all waves or multiple waves by ID.

This operation returns paginated results.

Synopsis

Creating a Request

data ListWaves Source #

See: newListWaves smart constructor.

Constructors

ListWaves'
Fields filters :: Maybe ListWavesRequestFilters Waves list filters. maxResults :: Maybe Natural Maximum results to return when listing waves. nextToken :: Maybe Text Request next token.

Instances

Instances details

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

newListWaves :: ListWaves Source #

Create a value of ListWaves 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:filters:ListWaves', listWaves_filters - Waves list filters.

$sel:maxResults:ListWaves', listWaves_maxResults - Maximum results to return when listing waves.

ListWaves, listWaves_nextToken - Request next token.

Request Lenses

listWaves_filters :: Lens' ListWaves (Maybe ListWavesRequestFilters) Source #

Waves list filters.

listWaves_maxResults :: Lens' ListWaves (Maybe Natural) Source #

Maximum results to return when listing waves.

listWaves_nextToken :: Lens' ListWaves (Maybe Text) Source #

Request next token.

Destructuring the Response

data ListWavesResponse Source #

See: newListWavesResponse smart constructor.

Constructors

ListWavesResponse'
Fields items :: Maybe [Wave] Waves list. nextToken :: Maybe Text Response next token. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListWavesResponse Source #
Instance details Defined in Amazonka.MGN.ListWaves Associated Types type Rep ListWavesResponse :: Type -> Type # Methods from :: ListWavesResponse -> Rep ListWavesResponse x # to :: Rep ListWavesResponse x -> ListWavesResponse #
Show ListWavesResponse Source #
Instance details Defined in Amazonka.MGN.ListWaves Methods showsPrec :: Int -> ListWavesResponse -> ShowS # show :: ListWavesResponse -> String # showList :: [ListWavesResponse] -> ShowS #
NFData ListWavesResponse Source #
Instance details Defined in Amazonka.MGN.ListWaves Methods rnf :: ListWavesResponse -> () #
Eq ListWavesResponse Source #
Instance details Defined in Amazonka.MGN.ListWaves Methods (==) :: ListWavesResponse -> ListWavesResponse -> Bool # (/=) :: ListWavesResponse -> ListWavesResponse -> Bool #
type Rep ListWavesResponse Source #
Instance details Defined in Amazonka.MGN.ListWaves type Rep ListWavesResponse = D1 ('MetaData "ListWavesResponse" "Amazonka.MGN.ListWaves" "amazonka-mgn-2.0-BuezedRYkBsCUJQfnWhjEk" 'False) (C1 ('MetaCons "ListWavesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Wave])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListWavesResponse Source #

Arguments

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

Create a value of ListWavesResponse 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:ListWavesResponse', listWavesResponse_items - Waves list.

ListWaves, listWavesResponse_nextToken - Response next token.

$sel:httpStatus:ListWavesResponse', listWavesResponse_httpStatus - The response's http status code.

Response Lenses

listWavesResponse_items :: Lens' ListWavesResponse (Maybe [Wave]) Source #

Waves list.

listWavesResponse_nextToken :: Lens' ListWavesResponse (Maybe Text) Source #

Response next token.

listWavesResponse_httpStatus :: Lens' ListWavesResponse Int Source #

The response's http status code.