---
updatedAt: 2025-11-12T01:08:36.000Z
agentTools:
  projectIndex: https://public.docs.kivera.io/llms.txt
---

# SYNTHETICS

<Embed url="https://docs.aws.amazon.com/" title="AWS documentation" provider="docs.aws.amazon.com" href="https://docs.aws.amazon.com/" />

# AssociateResource

```erlang
valid {
    input.Body.ResourceArn == STRING
    input.ReqMap.groupIdentifier == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# CreateCanary

```erlang
enum_BrowserType := [ "CHROME", "FIREFOX" ]
enum_DependencyType := [ "LambdaLayer" ]
enum_EncryptionMode := [ "SSE_S3", "SSE_KMS" ]
enum_ProvisionedResourceCleanupSetting := [ "AUTOMATIC", "OFF" ]
enum_ResourceToTag := [ "lambda-function" ]

valid {
    input.Body.Name == STRING
    input.Body.Code.S3Bucket == STRING
    input.Body.Code.S3Key == STRING
    input.Body.Code.S3Version == STRING
    input.Body.Code.ZipFile == BLOB
    input.Body.Code.Handler == STRING
    input.Body.Code.BlueprintTypes[_] == STRING
    input.Body.Code.Dependencies[_].Type == enum_DependencyType[_]
    input.Body.Code.Dependencies[_].Reference == STRING
    input.Body.ArtifactS3Location == STRING
    input.Body.ExecutionRoleArn == STRING
    input.Body.Schedule.Expression == STRING
    input.Body.Schedule.DurationInSeconds == LONG
    input.Body.Schedule.RetryConfig.MaxRetries == INTEGER
    input.Body.RunConfig.TimeoutInSeconds == INTEGER
    input.Body.RunConfig.MemoryInMB == INTEGER
    input.Body.RunConfig.ActiveTracing == BOOLEAN
    input.Body.RunConfig.EnvironmentVariables.STRING == STRING
    input.Body.RunConfig.EphemeralStorage == INTEGER
    input.Body.SuccessRetentionPeriodInDays == INTEGER
    input.Body.FailureRetentionPeriodInDays == INTEGER
    input.Body.RuntimeVersion == STRING
    input.Body.VpcConfig.SubnetIds[_] == STRING
    input.Body.VpcConfig.SecurityGroupIds[_] == STRING
    input.Body.VpcConfig.Ipv6AllowedForDualStack == BOOLEAN
    input.Body.ResourcesToReplicateTags[_] == enum_ResourceToTag[_]
    input.Body.ProvisionedResourceCleanup == enum_ProvisionedResourceCleanupSetting[_]
    input.Body.BrowserConfigs[_].BrowserType == enum_BrowserType[_]
    input.Body.Tags.STRING == STRING
    input.Body.ArtifactConfig.S3Encryption.EncryptionMode == enum_EncryptionMode[_]
    input.Body.ArtifactConfig.S3Encryption.KmsKeyArn == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# CreateGroup

```erlang
valid {
    input.Body.Name == STRING
    input.Body.Tags.STRING == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# DeleteCanary

```erlang
valid {
    input.ReqMap.name == STRING
    input.Qs.deleteLambda == BOOLEAN
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# DeleteGroup

```erlang
valid {
    input.ReqMap.groupIdentifier == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# DescribeCanaries

```erlang
valid {
    input.Body.NextToken == STRING
    input.Body.MaxResults == INTEGER
    input.Body.Names[_] == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# DescribeCanariesLastRun

```erlang
enum_BrowserType := [ "CHROME", "FIREFOX" ]

valid {
    input.Body.NextToken == STRING
    input.Body.MaxResults == INTEGER
    input.Body.Names[_] == STRING
    input.Body.BrowserType == enum_BrowserType[_]
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# DescribeRuntimeVersions

```erlang
valid {
    input.Body.NextToken == STRING
    input.Body.MaxResults == INTEGER
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# DisassociateResource

```erlang
valid {
    input.Body.ResourceArn == STRING
    input.ReqMap.groupIdentifier == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# GetCanary

```erlang
valid {
    input.ReqMap.name == STRING
    input.Qs.dryRunId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# GetCanaryRuns

```erlang
enum_RunType := [ "CANARY_RUN", "DRY_RUN" ]

valid {
    input.Body.NextToken == STRING
    input.Body.MaxResults == INTEGER
    input.Body.DryRunId == STRING
    input.Body.RunType == enum_RunType[_]
    input.ReqMap.name == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# GetGroup

```erlang
valid {
    input.ReqMap.groupIdentifier == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# ListAssociatedGroups

```erlang
valid {
    input.Body.NextToken == STRING
    input.Body.MaxResults == INTEGER
    input.ReqMap.resourceArn == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# ListGroupResources

```erlang
valid {
    input.Body.NextToken == STRING
    input.Body.MaxResults == INTEGER
    input.ReqMap.groupIdentifier == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# ListGroups

```erlang
valid {
    input.Body.NextToken == STRING
    input.Body.MaxResults == INTEGER
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# ListTagsForResource

```erlang
valid {
    input.ReqMap.resourceArn == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# StartCanary

```erlang
valid {
    input.ReqMap.name == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# StartCanaryDryRun

```erlang
enum_BrowserType := [ "CHROME", "FIREFOX" ]
enum_DependencyType := [ "LambdaLayer" ]
enum_EncryptionMode := [ "SSE_S3", "SSE_KMS" ]
enum_ProvisionedResourceCleanupSetting := [ "AUTOMATIC", "OFF" ]

valid {
    input.Body.Code.S3Bucket == STRING
    input.Body.Code.S3Key == STRING
    input.Body.Code.S3Version == STRING
    input.Body.Code.ZipFile == BLOB
    input.Body.Code.Handler == STRING
    input.Body.Code.BlueprintTypes[_] == STRING
    input.Body.Code.Dependencies[_].Type == enum_DependencyType[_]
    input.Body.Code.Dependencies[_].Reference == STRING
    input.Body.RuntimeVersion == STRING
    input.Body.RunConfig.TimeoutInSeconds == INTEGER
    input.Body.RunConfig.MemoryInMB == INTEGER
    input.Body.RunConfig.ActiveTracing == BOOLEAN
    input.Body.RunConfig.EnvironmentVariables.STRING == STRING
    input.Body.RunConfig.EphemeralStorage == INTEGER
    input.Body.VpcConfig.SubnetIds[_] == STRING
    input.Body.VpcConfig.SecurityGroupIds[_] == STRING
    input.Body.VpcConfig.Ipv6AllowedForDualStack == BOOLEAN
    input.Body.ExecutionRoleArn == STRING
    input.Body.SuccessRetentionPeriodInDays == INTEGER
    input.Body.FailureRetentionPeriodInDays == INTEGER
    input.Body.VisualReference.BaseScreenshots[_].ScreenshotName == STRING
    input.Body.VisualReference.BaseScreenshots[_].IgnoreCoordinates[_] == STRING
    input.Body.VisualReference.BaseCanaryRunId == STRING
    input.Body.VisualReference.BrowserType == enum_BrowserType[_]
    input.Body.ArtifactS3Location == STRING
    input.Body.ArtifactConfig.S3Encryption.EncryptionMode == enum_EncryptionMode[_]
    input.Body.ArtifactConfig.S3Encryption.KmsKeyArn == STRING
    input.Body.ProvisionedResourceCleanup == enum_ProvisionedResourceCleanupSetting[_]
    input.Body.BrowserConfigs[_].BrowserType == enum_BrowserType[_]
    input.Body.VisualReferences[_].BaseScreenshots[_].ScreenshotName == STRING
    input.Body.VisualReferences[_].BaseScreenshots[_].IgnoreCoordinates[_] == STRING
    input.Body.VisualReferences[_].BaseCanaryRunId == STRING
    input.Body.VisualReferences[_].BrowserType == enum_BrowserType[_]
    input.ReqMap.name == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# StopCanary

```erlang
valid {
    input.ReqMap.name == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# TagResource

```erlang
valid {
    input.Body.Tags.STRING == STRING
    input.ReqMap.resourceArn == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# UntagResource

```erlang
valid {
    input.ReqMap.resourceArn == STRING
    input.Qs.tagKeys[_] == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# UpdateCanary

```erlang
enum_BrowserType := [ "CHROME", "FIREFOX" ]
enum_DependencyType := [ "LambdaLayer" ]
enum_EncryptionMode := [ "SSE_S3", "SSE_KMS" ]
enum_ProvisionedResourceCleanupSetting := [ "AUTOMATIC", "OFF" ]

valid {
    input.Body.Code.S3Bucket == STRING
    input.Body.Code.S3Key == STRING
    input.Body.Code.S3Version == STRING
    input.Body.Code.ZipFile == BLOB
    input.Body.Code.Handler == STRING
    input.Body.Code.BlueprintTypes[_] == STRING
    input.Body.Code.Dependencies[_].Type == enum_DependencyType[_]
    input.Body.Code.Dependencies[_].Reference == STRING
    input.Body.ExecutionRoleArn == STRING
    input.Body.RuntimeVersion == STRING
    input.Body.Schedule.Expression == STRING
    input.Body.Schedule.DurationInSeconds == LONG
    input.Body.Schedule.RetryConfig.MaxRetries == INTEGER
    input.Body.RunConfig.TimeoutInSeconds == INTEGER
    input.Body.RunConfig.MemoryInMB == INTEGER
    input.Body.RunConfig.ActiveTracing == BOOLEAN
    input.Body.RunConfig.EnvironmentVariables.STRING == STRING
    input.Body.RunConfig.EphemeralStorage == INTEGER
    input.Body.SuccessRetentionPeriodInDays == INTEGER
    input.Body.FailureRetentionPeriodInDays == INTEGER
    input.Body.VpcConfig.SubnetIds[_] == STRING
    input.Body.VpcConfig.SecurityGroupIds[_] == STRING
    input.Body.VpcConfig.Ipv6AllowedForDualStack == BOOLEAN
    input.Body.VisualReference.BaseScreenshots[_].ScreenshotName == STRING
    input.Body.VisualReference.BaseScreenshots[_].IgnoreCoordinates[_] == STRING
    input.Body.VisualReference.BaseCanaryRunId == STRING
    input.Body.VisualReference.BrowserType == enum_BrowserType[_]
    input.Body.ArtifactS3Location == STRING
    input.Body.ArtifactConfig.S3Encryption.EncryptionMode == enum_EncryptionMode[_]
    input.Body.ArtifactConfig.S3Encryption.KmsKeyArn == STRING
    input.Body.ProvisionedResourceCleanup == enum_ProvisionedResourceCleanupSetting[_]
    input.Body.DryRunId == STRING
    input.Body.VisualReferences[_].BaseScreenshots[_].ScreenshotName == STRING
    input.Body.VisualReferences[_].BaseScreenshots[_].IgnoreCoordinates[_] == STRING
    input.Body.VisualReferences[_].BaseCanaryRunId == STRING
    input.Body.VisualReferences[_].BrowserType == enum_BrowserType[_]
    input.Body.BrowserConfigs[_].BrowserType == enum_BrowserType[_]
    input.ReqMap.name == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```