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.Synthetics.GetCanaryRuns

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a list of runs for a specified canary.

Creating a Request

data GetCanaryRuns Source #

See: newGetCanaryRuns smart constructor.

Constructors

GetCanaryRuns'

Fields

maxResults :: Maybe Natural
Specify this parameter to limit how many runs are returned each time you use the GetCanaryRuns operation. If you omit this parameter, the default of 100 is used.
nextToken :: Maybe Text
A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results.
name :: Text
The name of the canary that you want to see runs for.

Instances

Instances details

ToJSON GetCanaryRuns Source #
Instance details Defined in Amazonka.Synthetics.GetCanaryRuns Methods toJSON :: GetCanaryRuns -> Value # toEncoding :: GetCanaryRuns -> Encoding # toJSONList :: [GetCanaryRuns] -> Value # toEncodingList :: [GetCanaryRuns] -> Encoding #
ToHeaders GetCanaryRuns Source #
Instance details Defined in Amazonka.Synthetics.GetCanaryRuns Methods toHeaders :: GetCanaryRuns -> [Header] #
ToPath GetCanaryRuns Source #
Instance details Defined in Amazonka.Synthetics.GetCanaryRuns Methods toPath :: GetCanaryRuns -> ByteString #
ToQuery GetCanaryRuns Source #
Instance details Defined in Amazonka.Synthetics.GetCanaryRuns Methods toQuery :: GetCanaryRuns -> QueryString #
AWSRequest GetCanaryRuns Source #
Instance details Defined in Amazonka.Synthetics.GetCanaryRuns Associated Types type AWSResponse GetCanaryRuns # Methods request :: (Service -> Service) -> GetCanaryRuns -> Request GetCanaryRuns # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetCanaryRuns -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetCanaryRuns))) #
Generic GetCanaryRuns Source #
Instance details Defined in Amazonka.Synthetics.GetCanaryRuns Associated Types type Rep GetCanaryRuns :: Type -> Type # Methods from :: GetCanaryRuns -> Rep GetCanaryRuns x # to :: Rep GetCanaryRuns x -> GetCanaryRuns #
Read GetCanaryRuns Source #
Instance details Defined in Amazonka.Synthetics.GetCanaryRuns Methods readsPrec :: Int -> ReadS GetCanaryRuns # readList :: ReadS [GetCanaryRuns] # readPrec :: ReadPrec GetCanaryRuns # readListPrec :: ReadPrec [GetCanaryRuns] #
Show GetCanaryRuns Source #
Instance details Defined in Amazonka.Synthetics.GetCanaryRuns Methods showsPrec :: Int -> GetCanaryRuns -> ShowS # show :: GetCanaryRuns -> String # showList :: [GetCanaryRuns] -> ShowS #
NFData GetCanaryRuns Source #
Instance details Defined in Amazonka.Synthetics.GetCanaryRuns Methods rnf :: GetCanaryRuns -> () #
Eq GetCanaryRuns Source #
Instance details Defined in Amazonka.Synthetics.GetCanaryRuns Methods (==) :: GetCanaryRuns -> GetCanaryRuns -> Bool # (/=) :: GetCanaryRuns -> GetCanaryRuns -> Bool #
Hashable GetCanaryRuns Source #
Instance details Defined in Amazonka.Synthetics.GetCanaryRuns Methods hashWithSalt :: Int -> GetCanaryRuns -> Int # hash :: GetCanaryRuns -> Int #
type AWSResponse GetCanaryRuns Source #
Instance details Defined in Amazonka.Synthetics.GetCanaryRuns type AWSResponse GetCanaryRuns = GetCanaryRunsResponse
type Rep GetCanaryRuns Source #
Instance details Defined in Amazonka.Synthetics.GetCanaryRuns type Rep GetCanaryRuns = D1 ('MetaData "GetCanaryRuns" "Amazonka.Synthetics.GetCanaryRuns" "amazonka-synthetics-2.0-3I8gICXDswl2F1HDbijRHZ" 'False) (C1 ('MetaCons "GetCanaryRuns'" '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 "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetCanaryRuns Source #

Arguments

:: Text	`GetCanaryRuns`
-> GetCanaryRuns

Create a value of GetCanaryRuns 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:GetCanaryRuns', getCanaryRuns_maxResults - Specify this parameter to limit how many runs are returned each time you use the GetCanaryRuns operation. If you omit this parameter, the default of 100 is used.

GetCanaryRuns, getCanaryRuns_nextToken - A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results.

GetCanaryRuns, getCanaryRuns_name - The name of the canary that you want to see runs for.

Request Lenses

getCanaryRuns_maxResults :: Lens' GetCanaryRuns (Maybe Natural) Source #

Specify this parameter to limit how many runs are returned each time you use the GetCanaryRuns operation. If you omit this parameter, the default of 100 is used.

getCanaryRuns_nextToken :: Lens' GetCanaryRuns (Maybe Text) Source #

A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results.

getCanaryRuns_name :: Lens' GetCanaryRuns Text Source #

The name of the canary that you want to see runs for.

Destructuring the Response

data GetCanaryRunsResponse Source #

See: newGetCanaryRunsResponse smart constructor.

Constructors

GetCanaryRunsResponse'
Fields canaryRuns :: Maybe [CanaryRun] An array of structures. Each structure contains the details of one of the retrieved canary runs. nextToken :: Maybe Text A token that indicates that there is more data available. You can use this token in a subsequent `GetCanaryRuns` operation to retrieve the next set of results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetCanaryRunsResponse Source #

Arguments

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

Create a value of GetCanaryRunsResponse 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:canaryRuns:GetCanaryRunsResponse', getCanaryRunsResponse_canaryRuns - An array of structures. Each structure contains the details of one of the retrieved canary runs.

GetCanaryRuns, getCanaryRunsResponse_nextToken - A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results.

$sel:httpStatus:GetCanaryRunsResponse', getCanaryRunsResponse_httpStatus - The response's http status code.

Response Lenses

getCanaryRunsResponse_canaryRuns :: Lens' GetCanaryRunsResponse (Maybe [CanaryRun]) Source #

An array of structures. Each structure contains the details of one of the retrieved canary runs.

getCanaryRunsResponse_nextToken :: Lens' GetCanaryRunsResponse (Maybe Text) Source #

A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results.

getCanaryRunsResponse_httpStatus :: Lens' GetCanaryRunsResponse Int Source #

The response's http status code.