@aws-sdk/client-synthetics 3.650.0 → 3.651.0

package/dist-cjs/index.js

@@ -49,6 +49,7 @@ __export(src_exports, {
   NotFoundException: () => NotFoundException,
   RequestEntityTooLargeException: () => RequestEntityTooLargeException,
   ResourceNotFoundException: () => ResourceNotFoundException,
+  ResourceToTag: () => ResourceToTag,
   ServiceQuotaExceededException: () => ServiceQuotaExceededException,
   StartCanaryCommand: () => StartCanaryCommand,
   StopCanaryCommand: () => StopCanaryCommand,
@@ -382,6 +383,9 @@ var CanaryRunStateReasonCode = {
   CANARY_FAILURE: "CANARY_FAILURE",
   EXECUTION_FAILURE: "EXECUTION_FAILURE"
 };
+var ResourceToTag = {
+  LAMBDA_FUNCTION: "lambda-function"
+};
 var _RequestEntityTooLargeException = class _RequestEntityTooLargeException extends SyntheticsServiceException {
   /**
    * @internal
@@ -487,6 +491,7 @@ var se_CreateCanaryCommand = /* @__PURE__ */ __name(async (input, context) => {
       ExecutionRoleArn: [],
       FailureRetentionPeriodInDays: [],
       Name: [],
+      ResourcesToReplicateTags: (_) => (0, import_smithy_client._json)(_),
       RunConfig: (_) => (0, import_smithy_client._json)(_),
       RuntimeVersion: [],
       Schedule: (_) => (0, import_smithy_client._json)(_),
@@ -1719,6 +1724,7 @@ var paginateListGroups = (0, import_core.createPaginator)(SyntheticsClient, List
   CanaryStateReasonCode,
   CanaryRunState,
   CanaryRunStateReasonCode,
+  ResourceToTag,
   RequestEntityTooLargeException,
   InternalFailureException,
   NotFoundException,

package/dist-es/models/models_0.js

@@ -115,6 +115,9 @@ export const CanaryRunStateReasonCode = {
     CANARY_FAILURE: "CANARY_FAILURE",
     EXECUTION_FAILURE: "EXECUTION_FAILURE",
 };
+export const ResourceToTag = {
+    LAMBDA_FUNCTION: "lambda-function",
+};
 export class RequestEntityTooLargeException extends __BaseException {
     constructor(opts) {
         super({

package/dist-es/protocols/Aws_restJson1.js

@@ -31,6 +31,7 @@ export const se_CreateCanaryCommand = async (input, context) => {
         ExecutionRoleArn: [],
         FailureRetentionPeriodInDays: [],
         Name: [],
+        ResourcesToReplicateTags: (_) => _json(_),
         RunConfig: (_) => _json(_),
         RuntimeVersion: [],
         Schedule: (_) => _json(_),

package/dist-types/commands/CreateCanaryCommand.d.ts

@@ -81,6 +81,9 @@ declare const CreateCanaryCommand_base: {
  *       "STRING_VALUE",
  *     ],
  *   },
+ *   ResourcesToReplicateTags: [ // ResourceList
+ *     "lambda-function",
+ *   ],
  *   Tags: { // TagMap
  *     "<keys>": "STRING_VALUE",
  *   },

package/dist-types/commands/DeleteCanaryCommand.d.ts

@@ -37,8 +37,9 @@ declare const DeleteCanaryCommand_base: {
  *          <ul>
  *             <li>
  *                <p>The CloudWatch alarms created for this canary. These alarms have a name of
- *                      <code>Synthetics-SharpDrop-Alarm-<i>MyCanaryName</i>
- *                   </code>.</p>
+ *                <code>Synthetics-Alarm-<i>first-198-characters-of-canary-name</i>-<i>canaryId</i>-<i>alarm number</i>
+ *                   </code>
+ *                </p>
  *             </li>
  *             <li>
  *                <p>Amazon S3 objects and buckets, such as the canary's artifact location.</p>
@@ -46,13 +47,15 @@ declare const DeleteCanaryCommand_base: {
  *             <li>
  *                <p>IAM roles created for the canary. If they were created in the console, these roles
  *                have the name <code>
- *                      role/service-role/CloudWatchSyntheticsRole-<i>MyCanaryName</i>
- *                   </code>.</p>
+ *                      role/service-role/CloudWatchSyntheticsRole-<i>First-21-Characters-of-CanaryName</i>
+ *                   </code>
+ *                </p>
  *             </li>
  *             <li>
  *                <p>CloudWatch Logs log groups created for the canary. These logs groups have the name
- *                      <code>/aws/lambda/cwsyn-<i>MyCanaryName</i>
- *                   </code>. </p>
+ *                <code>/aws/lambda/cwsyn-<i>First-21-Characters-of-CanaryName</i>
+ *                   </code>
+ *                </p>
  *             </li>
  *          </ul>
  *          <p>Before you delete a canary, you might want to use <code>GetCanary</code> to display

package/dist-types/models/models_0.d.ts

@@ -613,6 +613,23 @@ export interface CanaryLastRun {
  *          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 <code>Zipfile</code>. </p>
+ *          <p>If you are uploading your canary scripts with an Amazon S3 bucket, your zip file should include your
+ *       script in a certain folder structure.</p>
+ *          <ul>
+ *             <li>
+ *                <p>For Node.js canaries, the folder structure must be <code>nodejs/node_modules/<i>myCanaryFilename.js</i>
+ *                   </code>
+ *             For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary_Nodejs.html#CloudWatch_Synthetics_Canaries_package">Packaging your Node.js canary files</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>For Python canaries, the folder structure must be <code>python/<i>myCanaryFilename.p</i>
+ *                   </code> or <code>python/<i>myFolder/myCanaryFilename.py</i>
+ *                   </code>
+ *             For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary_Python.html#CloudWatch_Synthetics_Canaries_WritingCanary_Python_package">Packaging your Python canary files</a>
+ *                </p>
+ *             </li>
+ *          </ul>
  * @public
  */
 export interface CanaryCodeInput {
@@ -738,6 +755,17 @@ export interface CanaryScheduleInput {
      */
     DurationInSeconds?: number;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const ResourceToTag: {
+    readonly LAMBDA_FUNCTION: "lambda-function";
+};
+/**
+ * @public
+ */
+export type ResourceToTag = (typeof ResourceToTag)[keyof typeof ResourceToTag];
 /**
  * <p>If this canary is to test an endpoint in a VPC, this structure contains
  *          information about the subnets and security groups of the VPC endpoint.
@@ -874,6 +902,14 @@ export interface CreateCanaryRequest {
      * @public
      */
     VpcConfig?: VpcConfigInput;
+    /**
+     * <p>To have the tags that you apply to this canary also be applied to the Lambda function that
+     *          the canary uses, specify this parameter with the value <code>lambda-function</code>.</p>
+     *          <p>If you specify this parameter and don't specify any tags in the <code>Tags</code>
+     *       parameter, the canary creation fails.</p>
+     * @public
+     */
+    ResourcesToReplicateTags?: ResourceToTag[];
     /**
      * <p>A list of key-value pairs to associate with the canary.
      *          You can associate as many as 50 tags with a canary.</p>
@@ -881,6 +917,8 @@ export interface CreateCanaryRequest {
      *          resources. You can also use them to scope user permissions, by
      *          granting a user permission to access or change only the resources that have
      *          certain tag values.</p>
+     *          <p>To have the tags that you apply to this canary also be applied to the Lambda function that
+     *          the canary uses, specify this parameter with the value <code>lambda-function</code>.</p>
      * @public
      */
     Tags?: Record<string, string>;
@@ -1032,7 +1070,7 @@ export interface DescribeCanariesRequest {
     NextToken?: string;
     /**
      * <p>Specify this parameter to limit how many canaries are returned each time you use
-     *       the <code>DescribeCanaries</code> operation. If you omit this parameter, the default of 100 is used.</p>
+     *       the <code>DescribeCanaries</code> operation. If you omit this parameter, the default of 20 is used.</p>
      * @public
      */
     MaxResults?: number;

package/dist-types/ts3.4/models/models_0.d.ts

@@ -201,6 +201,10 @@ export interface CanaryScheduleInput {
   Expression: string | undefined;
   DurationInSeconds?: number;
 }
+export declare const ResourceToTag: {
+  readonly LAMBDA_FUNCTION: "lambda-function";
+};
+export type ResourceToTag = (typeof ResourceToTag)[keyof typeof ResourceToTag];
 export interface VpcConfigInput {
   SubnetIds?: string[];
   SecurityGroupIds?: string[];
@@ -216,6 +220,7 @@ export interface CreateCanaryRequest {
   FailureRetentionPeriodInDays?: number;
   RuntimeVersion: string | undefined;
   VpcConfig?: VpcConfigInput;
+  ResourcesToReplicateTags?: ResourceToTag[];
   Tags?: Record<string, string>;
   ArtifactConfig?: ArtifactConfigInput;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-synthetics",
   "description": "AWS SDK for JavaScript Synthetics Client for Node.js, Browser and React Native",
-  "version": "3.650.0",
+  "version": "3.651.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-synthetics",