Describe Canaries Last Run
synthetics_describe_canaries_last_run | R Documentation |
Use this operation to see information from the most recent run of each canary that you have created¶
Description¶
Use this operation to see information from the most recent run of each canary that you have created.
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.
Usage¶
Arguments¶
NextToken
A token that indicates that there is more data available. You can use this token in a subsequent
describe_canaries_last_run
operation to retrieve the next set of results.MaxResults
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
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.
Value¶
A list with the following syntax:
list(
CanariesLastRun = list(
list(
CanaryName = "string",
LastRun = list(
Id = "string",
Name = "string",
Status = list(
State = "RUNNING"|"PASSED"|"FAILED",
StateReason = "string",
StateReasonCode = "CANARY_FAILURE"|"EXECUTION_FAILURE"
),
Timeline = list(
Started = as.POSIXct(
"2015-01-01"
),
Completed = as.POSIXct(
"2015-01-01"
)
),
ArtifactS3Location = "string"
)
)
),
NextToken = "string"
)