synthetics:GetCanary

Read

synthetics:GetCanary is a Read access-level action in the synthetics service. Grants permission to view the details of a canary

Resource types

ARNs that synthetics:GetCanary can be scoped to in an IAM policy.

arn:${Partition}:synthetics:${Region}:${Account}:canary:${CanaryName}
canary

Condition keys

Keys you can use in the Condition block of a policy that grants synthetics:GetCanary.

aws:ResourceTag/${TagKey} String

Filters access based on the tags associated with the resource

Example IAM policy

A minimal policy that allows synthetics:GetCanary. Replace "Resource": "*" with a specific ARN to follow least privilege.

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "AllowSyntheticsGetCanary",
      "Effect": "Allow",
      "Action": "synthetics:GetCanary",
      "Resource": "*"
    }
  ]
}

Related actions in synthetics

View all synthetics actions →