Documentation

Use this structure to input your script code for the canary. This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. If the script was passed into the canary directly, the script code is contained in the value of Zipfile.

See: newCanaryCodeInput smart constructor.

Create a value of CanaryCodeInput with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:s3Bucket:CanaryCodeInput', canaryCodeInput_s3Bucket - If your canary script is located in S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.

$sel:s3Key:CanaryCodeInput', canaryCodeInput_s3Key - The S3 key of your script. For more information, see Working with Amazon S3 Objects.

$sel:s3Version:CanaryCodeInput', canaryCodeInput_s3Version - The S3 version ID of your script.

$sel:zipFile:CanaryCodeInput', canaryCodeInput_zipFile - If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script. It must be smaller than 225 Kb.

For large canary scripts, we recommend that you use an S3 location instead of inputting it directly with this parameter.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:handler:CanaryCodeInput', canaryCodeInput_handler - The entry point to use for the source code when running the canary. For canaries that use the syn-python-selenium-1.0 runtime or a syn-nodejs.puppeteer runtime earlier than syn-nodejs.puppeteer-3.4, the handler must be specified as fileName.handler. For syn-python-selenium-1.1, syn-nodejs.puppeteer-3.4, and later runtimes, the handler can be specified as fileName.functionName , or you can specify a folder where canary scripts reside as folder/fileName.functionName .

If your canary script is located in S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.

The S3 key of your script. For more information, see Working with Amazon S3 Objects.

The S3 version ID of your script.

If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script. It must be smaller than 225 Kb.

For large canary scripts, we recommend that you use an S3 location instead of inputting it directly with this parameter.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

The entry point to use for the source code when running the canary. For canaries that use the syn-python-selenium-1.0 runtime or a syn-nodejs.puppeteer runtime earlier than syn-nodejs.puppeteer-3.4, the handler must be specified as fileName.handler. For syn-python-selenium-1.1, syn-nodejs.puppeteer-3.4, and later runtimes, the handler can be specified as fileName.functionName , or you can specify a folder where canary scripts reside as folder/fileName.functionName .