awscli 1.37.4__py3-none-any.whl → 1.37.6__py3-none-any.whl

awscli/examples/synthetics/describe-canaries.rst

@@ -0,0 +1,48 @@
+**To list canaries in your account**
+
+The following ``describe-canaries`` example lists the details of canaries in your account. ::
+
+    aws synthetics describe-canaries
+
+Output::
+
+    {
+        "Canaries": [
+            {
+                "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
+                "Name": "demo_canary",
+                "Code": {
+                    "SourceLocationArn": "arn:aws:lambda:us-east-1:123456789012:layer:cwsyn-demo_canary-a1b2c3d4-5678-90ab-cdef-example11111b8:1",
+                    "Handler": "pageLoadBlueprint.handler"
+                },
+                "ExecutionRoleArn": "arn:aws:iam::123456789012:role/service-role/CloudWatchSyntheticsRole-demo_canary-a12-a123bc456789",
+                "Schedule": {
+                    "Expression": "rate(5 minutes)",
+                    "DurationInSeconds": 0
+                },
+                "RunConfig": {
+                    "TimeoutInSeconds": 300,
+                    "MemoryInMB": 1000,
+                    "ActiveTracing": false
+                },
+                "SuccessRetentionPeriodInDays": 31,
+                "FailureRetentionPeriodInDays": 31,
+                "Status": {
+                "State": "RUNNING"
+                },
+                "Timeline": {
+                    "Created": "2024-10-15T18:55:15.168000+05:30",
+                    "LastModified": "2024-10-15T18:55:40.540000+05:30",
+                    "LastStarted": "2024-10-15T18:55:40.540000+05:30"
+                },
+                "ArtifactS3Location": "cw-syn-results-123456789012-us-east-1/canary/us-east-1/demo_canary-a12-a123bc456789",
+                "EngineArn": "arn:aws:lambda:us-east-1:123456789012:function:cwsyn-demo_canary-a1b2c3d4-5678-90ab-cdef-example111118:1",
+                "RuntimeVersion": "syn-nodejs-puppeteer-9.1",
+                "Tags": {
+                    "blueprint": "heartbeat"
+                }
+            }
+        ]
+    }
+
+For more information, see `Synthetic monitoring (canaries) <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/synthetics/describe-runtime-versions.rst

@@ -0,0 +1,74 @@
+**To return a list of synthetics canary runtime versions**
+
+The following ``describe-runtime-versions`` example returns the list of synthetics canary runtime versions. ::
+
+    aws synthetics describe-runtime-versions
+
+Output::
+
+    {
+        "RuntimeVersions": [
+            {
+                "VersionName": "syn-nodejs-puppeteer-9.1",
+                "Description": "Security fixes and bug fix for date range error in har. Dependencies: Node JS 20.x, Puppeteer-core 22.12.1, Chromium 126.0.6478.126",
+                "ReleaseDate": "2024-10-02T05:30:00+05:30"
+            },
+            {
+                "VersionName": "syn-nodejs-puppeteer-9.0",
+                "Description": "Upgraded Chromium and Puppeteer. Dependencies: Node JS 20.x, Puppeteer-core 22.12.1, Chromium 126.0.6478.126",
+                "ReleaseDate": "2024-07-22T05:30:00+05:30"
+            },
+            {
+                "VersionName": "syn-nodejs-puppeteer-8.0",
+                "Description": "Upgraded Chromium and Puppeteer. Dependencies: Node JS 20.x, Puppeteer-core 22.10.0, Chromium 125.0.6422.112",
+                "ReleaseDate": "2024-06-21T05:30:00+05:30"
+            },
+            {
+                "VersionName": "syn-nodejs-puppeteer-7.0",
+                "Description": "Upgraded Chromium and Puppeteer. Dependencies: Node JS 18.x, Puppeteer-core 21.9.0, Chromium 121.0.6167.139",
+                "ReleaseDate": "2024-03-08T05:30:00+05:30"
+                },
+            {
+                "VersionName": "syn-nodejs-puppeteer-6.2",
+                "Description": "Updated shared libraries for Chromium and added ephemeral storage monitoring. Dependencies: Node JS 18.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146",
+                "ReleaseDate": "2024-02-02T05:30:00+05:30"
+            },
+            {
+                "VersionName": "syn-nodejs-puppeteer-6.1",
+                "Description": "Added puppeteer launch retry. Dependencies: Node JS 18.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146",
+                "ReleaseDate": "2023-11-13T05:30:00+05:30",
+                "DeprecationDate": "2024-03-08T13:30:00+05:30"
+            },
+            {
+                "VersionName": "syn-nodejs-puppeteer-6.0",
+                "Description": "Reduced X-Ray traces of a canary run, improved duration metric and upgraded to NodeJS 18.x. Dependencies: Node JS 18.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146",
+                "ReleaseDate": "2023-09-15T05:30:00+05:30",
+                "DeprecationDate": "2024-03-08T13:30:00+05:30"
+            },
+            {
+                "VersionName": "syn-nodejs-puppeteer-5.2",
+                "Description": "Updated shared libraries for Chromium. Dependencies: Node JS 16.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146",
+                "ReleaseDate": "2024-02-01T05:30:00+05:30"
+            },
+            {
+                "VersionName": "syn-nodejs-puppeteer-5.1",
+                "Description": "Fixes a bug about missing request headers in har. Dependencies: Node JS 16.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146",
+                "ReleaseDate": "2023-08-09T05:30:00+05:30",
+                "DeprecationDate": "2024-03-08T13:30:00+05:30"
+            },
+            {
+                "VersionName": "syn-nodejs-puppeteer-5.0",
+                "Description": "Upgraded Puppeteer and Chromium. Dependencies: Node JS 16.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146",
+                "ReleaseDate": "2023-07-21T05:30:00+05:30",
+                "DeprecationDate": "2024-03-08T13:30:00+05:30"
+            },
+            {
+                "VersionName": "syn-nodejs-puppeteer-4.0",
+                "Description": "Upgraded to NodeJS 16.x. Dependencies: Node JS 16.x, Puppeteer-core 5.5.0, Chromium 92.0.4512.0",
+                "ReleaseDate": "2023-05-01T05:30:00+05:30",
+                "DeprecationDate": "2024-03-08T13:30:00+05:30"
+            }
+        ]
+    }
+
+For more information, see `Synthetic monitoring (canaries) <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/synthetics/disassociate-resource.rst

@@ -0,0 +1,11 @@
+**To remove a canary from a group**
+
+The following ``disassociate-resource`` example removes a canary from the group named ``demo_group``. ::
+
+    aws synthetics disassociate-resource \
+        --group-identifier demo_group \
+        --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary
+
+This command produces no output.
+
+For more information, see `Synthetic monitoring (canaries) <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/synthetics/get-canary-runs.rst

@@ -0,0 +1,29 @@
+**To retrieve a list of runs for a specified canary**
+
+The following ``get-canary-runs`` example retrieves a list of runs for the canary named ``demo_canary``. ::
+
+    aws synthetics get-canary-runs \
+        --name demo_canary
+
+Output::
+
+    {
+        "CanaryRuns": [
+            {
+                "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
+                "Name": "demo_canary",
+                "Status": {
+                    "State": "PASSED",
+                    "StateReason": "",
+                    "StateReasonCode": ""
+                },
+                "Timeline": {
+                    "Started": "2024-10-16T10:38:57.013000+05:30",
+                    "Completed": "2024-10-16T10:39:25.793000+05:30"
+                },
+                "ArtifactS3Location": "cw-syn-results-123456789012-us-east-1/canary/us-east-1/demo_canary-abc-example1234/2024/10/15/13/50-39-690"
+            }
+        ]
+    }
+
+For more information, see `Synthetic monitoring (canaries) <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/synthetics/get-canary.rst

@@ -0,0 +1,47 @@
+**To retrieve complete information about one canary**
+
+The following ``get-canary`` example retrieves complete information about the canary named ``demo_canary``. ::
+
+    aws synthetics get-canary \
+        --name demo_canary
+
+Output::
+
+    {
+        "Canary": {
+            "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
+            "Name": "demo_canary",
+            "Code": {
+                "SourceLocationArn": "arn:aws:lambda:us-east-1:123456789012:layer:cwsyn-demo_canary-a1b2c3d4-5678-90ab-cdef-example111118:1",
+                "Handler": "pageLoadBlueprint.handler"
+            },
+            "ExecutionRoleArn": "arn:aws:iam::123456789012:role/demo_canary_role",
+            "Schedule": {
+                "Expression": "rate(10 minutes)",
+                "DurationInSeconds": 0
+            },
+            "RunConfig": {
+                "TimeoutInSeconds": 300,
+                "MemoryInMB": 1000,
+                "ActiveTracing": false
+            },
+            "SuccessRetentionPeriodInDays": 31,
+            "FailureRetentionPeriodInDays": 31,
+            "Status": {
+                "State": "RUNNING"
+            },
+            "Timeline": {
+                "Created": "2024-10-15T18:55:15.168000+05:30",
+                "LastModified": "2024-10-15T18:55:40.540000+05:30",
+                "LastStarted": "2024-10-15T18:55:40.540000+05:30"
+            },
+            "ArtifactS3Location": "cw-syn-results-123456789012-us-east-1/canary/us-east-1/demo_canary-a12-a123bc456789",
+            "EngineArn": "arn:aws:lambda:us-east-1:123456789012:function:cwsyn-demo_canary-a1b2c3d4-5678-90ab-cdef-example111118:1",
+            "RuntimeVersion": "syn-nodejs-puppeteer-9.1",
+            "Tags": {
+                "blueprint": "heartbeat"
+            }
+        }
+    }
+
+For more information, see `Synthetic monitoring (canaries) <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/synthetics/get-group.rst

@@ -0,0 +1,21 @@
+**To return information about one group**
+
+The following ``get-group`` example returns information about the group named ``demo_group``. ::
+
+    aws synthetics get-group \
+        --group-identifier demo_group
+
+Output::
+
+    {
+        "Group": {
+            "Id": "example123",
+            "Name": "demo_group",
+            "Arn": "arn:aws:synthetics:us-east-1:123456789012:group:example123",
+            "Tags": {},
+            "CreatedTime": "2024-10-15T14:47:23.811000+05:30",
+            "LastModifiedTime": "2024-10-15T14:47:23.811000+05:30"
+        }
+    }
+
+For more information, see `Synthetic monitoring (canaries) <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/synthetics/list-associated-groups.rst

@@ -0,0 +1,20 @@
+**To return a list of the groups**
+
+The following ``list-associated-groups`` example returns a list of the groups associated with the canary named ``demo_canary``. ::
+
+    aws synthetics list-associated-groups \
+        --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary
+
+Output::
+
+    {
+        "Groups": [
+            {
+                "Id": "example123",
+                "Name": "demo_group",
+                "Arn": "arn:aws:synthetics:us-east-1:123456789012:group:example123"
+            }
+        ]
+    }
+
+For more information, see `Synthetic monitoring (canaries) <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/synthetics/list-group-resources.rst

@@ -0,0 +1,16 @@
+**To return a list of the ARNs of the canaries that are associated with the specified group**
+
+The following ``list-group-resources`` example returns a list of the ARNs of the canaries that are associated with the group named ``demo_group``. ::
+
+    aws synthetics list-group-resources \
+        --group-identifier demo_group
+
+Output::
+
+    {
+        "Resources": [
+            "arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary"
+        ]
+    }
+
+For more information, see `Synthetic monitoring (canaries) <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/synthetics/list-groups.rst

@@ -0,0 +1,19 @@
+**To return a list of all groups in the account**
+
+The following ``list-groups`` example returns a list of all groups in the account. ::
+
+    aws synthetics list-groups
+
+Output::
+
+    {
+        "Groups": [
+            {
+                "Id": "example123",
+                "Name": "demo_group",
+                "Arn": "arn:aws:synthetics:us-east-1:123456789012:group:example123"
+            }
+        ]
+    }
+
+For more information, see `Synthetic monitoring (canaries) <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/synthetics/list-tags-for-resource.rst

@@ -0,0 +1,31 @@
+**Example 1: To display the tags associated with a canary**
+
+The following ``list-tags-for-resource`` example returns the tags associated with a canary named ``demo_canary``. ::
+
+    aws synthetics list-tags-for-resource \
+        --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary
+
+Output::
+
+    {
+        "Tags": {
+            "blueprint": "heartbeat"
+        }
+    }
+
+**Example 2: To display the tags associated with a group**
+
+The following ``list-tags-for-resource`` example returns the tags associated with a group named ``demo_group``. ::
+
+    aws  synthetics list-tags-for-resource \
+        --resource-arn arn:aws:synthetics:us-east-1:123456789012:group:example123
+
+Output::
+
+    {
+        "Tags": {
+            "team": "Devops"
+        }
+    }
+
+For more information, see `Synthetic monitoring (canaries) <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/synthetics/start-canary.rst

@@ -0,0 +1,10 @@
+**To run a canary**
+
+The following ``start-canary`` example runs a canary named ``demo_canary``. ::
+
+    aws synthetics start-canary \
+        --name demo_canary
+
+This command produces no output.
+
+For more information, see `Synthetic monitoring (canaries) <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/synthetics/stop-canary.rst

@@ -0,0 +1,10 @@
+**To stop a canary**
+
+The following ``stop-canary`` example stops the canary named ``demo_canary``. ::
+
+    aws synthetics stop-canary \
+        --name demo_canary
+
+This command produces no output.
+
+For more information, see `Synthetic monitoring (canaries) <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/synthetics/tag-resource.rst

@@ -0,0 +1,21 @@
+**Example 1: To assign a tag to the canary**
+
+The following ``tag-resource`` example assigns a tag to the canary named ``demo_canary``. ::
+
+    aws synthetics tag-resource \
+        --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary \
+        --tags blueprint=heartbeat
+
+This command produces no output.
+
+**Example 2: To assign a tag to the group**
+
+The following ``tag-resource`` example assigns a tag to the group named ``demo_group``. ::
+
+    aws synthetics tag-resource \
+        --resource-arn arn:aws:synthetics:us-east-1:123456789012:group:example123 \
+        --tags team=Devops
+
+This command produces no output.
+
+For more information, see `Synthetic monitoring (canaries) <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/synthetics/untag-resource.rst

@@ -0,0 +1,21 @@
+**Example 1: To remove a tag from the canary**
+
+The following ``untag-resource`` example removes a tag from the canary named ``demo_canary``. ::
+
+    aws synthetics untag-resource \
+        --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary \
+        --tag-keys blueprint
+
+This command produces no output.
+
+**Example 2: To remove a tag from the group**
+
+The following ``untag-resource`` example assigns a removes a tag from the group named ``demo_group``. ::
+
+    aws synthetics untag-resource \
+        --resource-arn arn:aws:synthetics:us-east-1:123456789012:group:example123 \
+        --tag-keys team
+
+This command produces no output.
+
+For more information, see `Synthetic monitoring (canaries) <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/synthetics/update-canary.rst

@@ -0,0 +1,11 @@
+**To update a canary**
+
+The following ``update-canary`` example updates the configuration of a canary named ``demo_canary``. ::
+
+    aws synthetics update-canary \
+        --name demo_canary \
+        --schedule Expression="rate(15 minutes)"
+
+This command produces no output.
+
+For more information, see `Synthetic monitoring (canaries) <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html>`__ in the *Amazon CloudWatch User Guide*.

{awscli-1.37.4.dist-info → awscli-1.37.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: awscli
-Version: 1.37.4
+Version: 1.37.6
 Summary: Universal Command Line Environment for AWS.
 Home-page: http://aws.amazon.com/cli/
 Author: Amazon Web Services
@@ -23,7 +23,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >= 3.8
 License-File: LICENSE.txt
-Requires-Dist: botocore (==1.36.4)
+Requires-Dist: botocore (==1.36.6)
 Requires-Dist: docutils (<0.17,>=0.10)
 Requires-Dist: s3transfer (<0.12.0,>=0.11.0)
 Requires-Dist: PyYAML (<6.1,>=3.10)