Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Synthetics.DescribeCanaries

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This operation returns a list of the canaries in your account, along with full details about each canary.

This operation does not have resource-level authorization, so if a user is able to use DescribeCanaries, the user can see all of the canaries in the account. A deny policy can only be used to restrict access to all canaries. It cannot be used on specific resources.

Creating a Request

data DescribeCanaries Source #

See: newDescribeCanaries smart constructor.

Constructors

DescribeCanaries'
Fields nextToken :: Maybe Text A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results. maxResults :: Maybe Natural Specify this parameter to limit how many canaries are returned each time you use the `DescribeCanaries` operation. If you omit this parameter, the default of 100 is used.

Instances

Instances details

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

newDescribeCanaries :: DescribeCanaries Source #

Create a value of DescribeCanaries 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:nextToken:DescribeCanaries', describeCanaries_nextToken - A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

$sel:maxResults:DescribeCanaries', describeCanaries_maxResults - Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation. If you omit this parameter, the default of 100 is used.

Request Lenses

describeCanaries_nextToken :: Lens' DescribeCanaries (Maybe Text) Source #

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

describeCanaries_maxResults :: Lens' DescribeCanaries (Maybe Natural) Source #

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

Destructuring the Response

data DescribeCanariesResponse Source #

See: newDescribeCanariesResponse smart constructor.

Constructors

DescribeCanariesResponse'
Fields canaries :: Maybe [Canary] Returns an array. Each item in the array contains the full information about one canary. nextToken :: Maybe Text A token that indicates that there is more data available. You can use this token in a subsequent `DescribeCanaries` operation to retrieve the next set of results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeCanariesResponse Source #

Arguments

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

Create a value of DescribeCanariesResponse 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:canaries:DescribeCanariesResponse', describeCanariesResponse_canaries - Returns an array. Each item in the array contains the full information about one canary.

$sel:nextToken:DescribeCanaries', describeCanariesResponse_nextToken - A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanaries operation to retrieve the next set of results.

$sel:httpStatus:DescribeCanariesResponse', describeCanariesResponse_httpStatus - The response's http status code.

Response Lenses

describeCanariesResponse_canaries :: Lens' DescribeCanariesResponse (Maybe [Canary]) Source #

Returns an array. Each item in the array contains the full information about one canary.

describeCanariesResponse_nextToken :: Lens' DescribeCanariesResponse (Maybe Text) Source #

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

describeCanariesResponse_httpStatus :: Lens' DescribeCanariesResponse Int Source #

The response's http status code.