Skip to content

DescribeCanariesResponse

Source code in docs_src/capo_synthetics/types/describe_canaries_response.py 
12
13
14
15
16
class DescribeCanariesResponse(TypedDict, closed=True):
    canaries: NotRequired["capo_synthetics.types.canaries.Canaries"]
    """<p>Returns an array. Each item in the array contains the full information about one canary.</p>"""
    next_token: NotRequired["capo_synthetics.types.token.Token"]
    """<p>A token that indicates that there is more data available. You can use this token in a subsequent <code>DescribeCanaries</code> operation to retrieve the next set of results.</p>"""

canaries instance-attribute 

canaries: NotRequired[Canaries]

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

next_token instance-attribute 

next_token: NotRequired[Token]

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.