Amazonka.Synthetics.DescribeCanaries

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

This operation supports resource-level authorization using an IAM policy and the Names parameter. If you specify the Names parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use the Names parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

Creating a Request

data DescribeCanaries

See: newDescribeCanaries smart constructor.

Constructors

DescribeCanaries'

Fields

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

• names :: Maybe (NonEmpty Text)

  Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.

  If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

  You are required to use this parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

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

Instances

ToJSON DescribeCanaries

Defined in Amazonka.Synthetics.DescribeCanaries

Methods

toJSON :: DescribeCanaries -> Value

toEncoding :: DescribeCanaries -> Encoding

toJSONList :: [DescribeCanaries] -> Value

toEncodingList :: [DescribeCanaries] -> Encoding

ToHeaders DescribeCanaries

Defined in Amazonka.Synthetics.DescribeCanaries

Methods

toHeaders :: DescribeCanaries -> [Header]

ToPath DescribeCanaries

Defined in Amazonka.Synthetics.DescribeCanaries

Methods

toPath :: DescribeCanaries -> ByteString

ToQuery DescribeCanaries

Defined in Amazonka.Synthetics.DescribeCanaries

Methods

toQuery :: DescribeCanaries -> QueryString

AWSRequest DescribeCanaries

Defined in Amazonka.Synthetics.DescribeCanaries

Associated Types

type AWSResponse DescribeCanaries

Methods

request :: (Service -> Service) -> DescribeCanaries -> Request DescribeCanaries

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeCanaries -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeCanaries)))

Generic DescribeCanaries

Defined in Amazonka.Synthetics.DescribeCanaries

Associated Types

type Rep DescribeCanaries :: Type -> Type

Methods

from :: DescribeCanaries -> Rep DescribeCanaries x

to :: Rep DescribeCanaries x -> DescribeCanaries

Read DescribeCanaries

Defined in Amazonka.Synthetics.DescribeCanaries

Methods

readsPrec :: Int -> ReadS DescribeCanaries

readList :: ReadS [DescribeCanaries]

readPrec :: ReadPrec DescribeCanaries

readListPrec :: ReadPrec [DescribeCanaries]

Show DescribeCanaries

Defined in Amazonka.Synthetics.DescribeCanaries

Methods

showsPrec :: Int -> DescribeCanaries -> ShowS

show :: DescribeCanaries -> String

showList :: [DescribeCanaries] -> ShowS

NFData DescribeCanaries

Defined in Amazonka.Synthetics.DescribeCanaries

Methods

rnf :: DescribeCanaries -> ()

Eq DescribeCanaries

Defined in Amazonka.Synthetics.DescribeCanaries

Methods

(==) :: DescribeCanaries -> DescribeCanaries -> Bool

(/=) :: DescribeCanaries -> DescribeCanaries -> Bool

Hashable DescribeCanaries

Defined in Amazonka.Synthetics.DescribeCanaries

Methods

hashWithSalt :: Int -> DescribeCanaries -> Int

hash :: DescribeCanaries -> Int

type AWSResponse DescribeCanaries

Defined in Amazonka.Synthetics.DescribeCanaries

type AWSResponse DescribeCanaries = DescribeCanariesResponse

type Rep DescribeCanaries

Defined in Amazonka.Synthetics.DescribeCanaries

type Rep DescribeCanaries = D1 ('MetaData "DescribeCanaries" "Amazonka.Synthetics.DescribeCanaries" "amazonka-synthetics-2.0-3I8gICXDswl2F1HDbijRHZ" 'False) (C1 ('MetaCons "DescribeCanaries'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "names") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeCanaries :: DescribeCanaries

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

$sel:names:DescribeCanaries', describeCanaries_names - Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.

If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use this parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

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.

Request Lenses

describeCanaries_maxResults :: Lens' DescribeCanaries (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.

describeCanaries_names :: Lens' DescribeCanaries (Maybe (NonEmpty Text))

Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.

If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use this parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

describeCanaries_nextToken :: Lens' DescribeCanaries (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.

Destructuring the Response

data DescribeCanariesResponse

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

Generic DescribeCanariesResponse

Defined in Amazonka.Synthetics.DescribeCanaries

Associated Types

type Rep DescribeCanariesResponse :: Type -> Type

Methods

from :: DescribeCanariesResponse -> Rep DescribeCanariesResponse x

to :: Rep DescribeCanariesResponse x -> DescribeCanariesResponse

Read DescribeCanariesResponse

Defined in Amazonka.Synthetics.DescribeCanaries

Methods

readsPrec :: Int -> ReadS DescribeCanariesResponse

readList :: ReadS [DescribeCanariesResponse]

readPrec :: ReadPrec DescribeCanariesResponse

readListPrec :: ReadPrec [DescribeCanariesResponse]

Show DescribeCanariesResponse

Defined in Amazonka.Synthetics.DescribeCanaries

Methods

showsPrec :: Int -> DescribeCanariesResponse -> ShowS

show :: DescribeCanariesResponse -> String

showList :: [DescribeCanariesResponse] -> ShowS

NFData DescribeCanariesResponse

Defined in Amazonka.Synthetics.DescribeCanaries

Methods

rnf :: DescribeCanariesResponse -> ()

Eq DescribeCanariesResponse

Defined in Amazonka.Synthetics.DescribeCanaries

Methods

(==) :: DescribeCanariesResponse -> DescribeCanariesResponse -> Bool

(/=) :: DescribeCanariesResponse -> DescribeCanariesResponse -> Bool

type Rep DescribeCanariesResponse

Defined in Amazonka.Synthetics.DescribeCanaries

type Rep DescribeCanariesResponse = D1 ('MetaData "DescribeCanariesResponse" "Amazonka.Synthetics.DescribeCanaries" "amazonka-synthetics-2.0-3I8gICXDswl2F1HDbijRHZ" '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

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.

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])

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

describeCanariesResponse_nextToken :: Lens' DescribeCanariesResponse (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.

describeCanariesResponse_httpStatus :: Lens' DescribeCanariesResponse Int

The response's http status code.