Skip to content

DescribeCanariesLastRunRequest

Source code in docs_src/capo_synthetics/types/describe_canaries_last_run_request.py 
14
15
16
17
18
19
20
21
22
23
24
class DescribeCanariesLastRunRequest(TypedDict, closed=True):
    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>DescribeCanariesLastRun</code> operation to retrieve the next set of results.</p>"""
    max_results: NotRequired["capo_synthetics.types.max_size100.MaxSize100"]
    """<p>Specify this parameter to limit how many runs are returned each time you use the <code>DescribeLastRun</code> operation. If you omit this parameter, the default of 100 is used.</p>"""
    names: NotRequired[
        "capo_synthetics.types.describe_canaries_last_run_name_filter.DescribeCanariesLastRunNameFilter"
    ]
    """<p>Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.</p> <p>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.</p> <p>You are required to use the <code>Names</code> 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 <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html"> Limiting a user to viewing specific canaries</a>.</p>"""
    browser_type: NotRequired["capo_synthetics.types.browser_type.BrowserType"]
    """<p>The type of browser to use for the canary run.</p>"""

browser_type instance-attribute 

browser_type: NotRequired[BrowserType]

The type of browser to use for the canary run.

max_results instance-attribute 

max_results: NotRequired[MaxSize100]

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

names instance-attribute 

names: NotRequired[DescribeCanariesLastRunNameFilter]

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

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 DescribeCanariesLastRun operation to retrieve the next set of results.