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

awscli/examples/oam/list-attached-links.rst

@@ -0,0 +1,23 @@
+**To return a list of source account links that are linked to this monitoring account sink**
+
+The following ``list-attached-links`` example returns a list of source account links that are linked to this monitoring account sink. ::
+
+    aws oam list-attached-links \
+        --sink-identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345
+
+Output::
+
+    {
+        "Items": [{
+            "Label": "Monitoring account",
+            "LinkArn": "arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111",
+            "ResourceTypes": [
+                "AWS::ApplicationInsights::Application",
+                "AWS::Logs::LogGroup",
+                "AWS::CloudWatch::Metric",
+                "AWS::XRay::Trace"
+            ]
+        }]
+    }
+
+For more information, see `CloudWatch cross-account observability <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/oam/list-links.rst

@@ -0,0 +1,21 @@
+**To return a list of links for one monitoring account sink**
+
+The following ``list-links`` example returns a list of links for one monitoring account sink. Run this operation in a source account to return a list of links to monitoring account sinks that this source account has. ::
+
+    aws oam list-links
+
+Output::
+
+    {
+        "Items": [{
+            "Arn": "arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111",
+            "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
+            "Label": "sourceAccount",
+            "ResourceTypes": [
+                "AWS::CloudWatch::Metric"
+            ],
+            "SinkArn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345"
+        }]
+    }
+
+For more information, see `CloudWatch cross-account observability <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/oam/list-sinks.rst

@@ -0,0 +1,19 @@
+**To return the list of sinks created in the monitoring account**
+
+The following ``list-sinks`` example returns a list of sinks created in the monitoring account. Run this operation in a monitoring account. ::
+
+    aws oam list-sinks
+
+Output::
+
+    {
+        "Items": [
+            {
+                "Arn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345",
+                "Id": "a1b2c3d4-5678-90ab-cdef-example12345",
+                "Name": "DemoSink"
+            }
+        ]
+    }
+
+For more information, see `CloudWatch cross-account observability <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html>`__ in the *Amazon CloudWatch User Guide*.

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

@@ -0,0 +1,16 @@
+**To display the tags associated with a resource**
+
+The following ``list-tags-for-resource`` example displays the tags associated with a sink. ::
+
+    aws oam list-tags-for-resource \
+        --resource-arn arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345
+
+Output::
+
+    {
+        "Tags": {
+            "Team": "Devops"
+        }
+    }
+
+For more information, see `CloudWatch cross-account observability <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/oam/put-sink-policy.rst

@@ -0,0 +1,17 @@
+**To create or update the resource policy**
+
+The following ``put-sink-policy`` example creates the resource policy that grants permissions to source accounts to link to the monitoring account sink. ::
+
+    aws oam put-sink-policy \
+        --policy '{"Version":"2012-10-17","Statement":[{"Effect":"Allow","Principal":{"AWS":"arn:aws:iam::123456789111:root"},"Action":["oam:CreateLink","oam:UpdateLink"],"Resource":"*","Condition":{"ForAllValues:StringEquals":{"oam:ResourceTypes":["AWS::Logs::LogGroup","AWS::CloudWatch::Metric","AWS::XRay::Trace","AWS::ApplicationInsights::Application"]}}}]}' \
+        --sink-identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345
+
+Output::
+
+    {
+        "SinkArn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345",
+        "SinkId": "a1b2c3d4-5678-90ab-cdef-example12345",
+        "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789111:root\"},\"Action\":[\"oam:CreateLink\",\"oam:UpdateLink\"],\"Resource\":\"*\",\"Condition\":{\"ForAllValues:StringEquals\":{\"oam:ResourceTypes\":[\"AWS::Logs::LogGroup\",\"AWS::CloudWatch::Metric\",\"AWS::XRay::Trace\",\"AWS::ApplicationInsights::Application\"]}}}]}"
+    }
+
+For more information, see `CloudWatch cross-account observability <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/oam/tag-resource.rst

@@ -0,0 +1,11 @@
+**To assign one or more tags to the specified resource**
+
+The following ``tag-resource`` example tags a sink ``arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345``. ::
+
+    aws oam tag-resource \
+        --resource-arn arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345 \
+        --tags team=Devops
+
+This command produces no output.
+
+For more information, see `CloudWatch cross-account observability <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/oam/untag-resource.rst

@@ -0,0 +1,11 @@
+**To remove one or more tags from the specified resource.**
+
+The following ``untag-resource`` example removes a tag with the key ``team`` from sink ``arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345``. ::
+
+    aws oam untag-resource \
+        --resource-arn arn:aws:oam:us-east-2:123456789012:sink/f3f42f60-f0f2-425c-1234-12347bdd821f \
+        --tag-keys team
+
+This command produces no output.
+
+For more information, see `CloudWatch cross-account observability <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/oam/update-link.rst

@@ -0,0 +1,24 @@
+**To change what types of data are shared from a source account to its linked monitoring account sink**
+
+The following ``update-link`` example updates the link ``arn:aws:oam:us-east-2:123456789111:link/0123e691-e7ef-43fa-1234-c57c837fced0`` with resource types ``AWS::CloudWatch::Metric`` and ``AWS::Logs::LogGroup``. ::
+
+    aws oam update-link \
+        --identifier arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111 \
+        --resource-types "AWS::CloudWatch::Metric" "AWS::Logs::LogGroup"
+
+Output::
+
+    {
+        "Arn": "arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111",
+        "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
+        "Label": "sourceAccount",
+        "LabelTemplate": "sourceAccount",
+        "ResourceTypes": [
+            "AWS::CloudWatch::Metric",
+            "AWS::Logs::LogGroup"
+        ],
+        "SinkArn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345",
+        "Tags": {}
+    }
+
+For more information, see `CloudWatch cross-account observability <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/polly/get-speech-synthesis-task.rst

@@ -1,23 +1,23 @@
-**To get information about a speech synthesis task**
-
-The following ``get-speech-synthesis-task`` example retrieves information about the specified speech synthesis task. ::
-
-    aws polly get-speech-synthesis-task \
-        --task-id 70b61c0f-57ce-4715-a247-cae8729dcce9
-
-Output::
-
-    {
-        "SynthesisTask": {
-            "TaskId": "70b61c0f-57ce-4715-a247-cae8729dcce9",
-            "TaskStatus": "completed",
-            "OutputUri": "https://s3.us-west-2.amazonaws.com/my-s3-bucket/70b61c0f-57ce-4715-a247-cae8729dcce9.mp3",
-            "CreationTime": 1603911042.689,
-            "RequestCharacters": 1311,
-            "OutputFormat": "mp3",
-            "TextType": "text",
-            "VoiceId": "Joanna"
-        }
-    }
-
-For more information, see `Creating long audio files <https://docs.aws.amazon.com/polly/latest/dg/longer-cli.html>`__ in the *Amazon Polly Developer Guide*.
+**To get information about a speech synthesis task**
+
+The following ``get-speech-synthesis-task`` example retrieves information about the specified speech synthesis task. ::
+
+    aws polly get-speech-synthesis-task \
+        --task-id 70b61c0f-57ce-4715-a247-cae8729dcce9
+
+Output::
+
+    {
+        "SynthesisTask": {
+            "TaskId": "70b61c0f-57ce-4715-a247-cae8729dcce9",
+            "TaskStatus": "completed",
+            "OutputUri": "https://s3.us-west-2.amazonaws.com/amzn-s3-demo-bucket/70b61c0f-57ce-4715-a247-cae8729dcce9.mp3",
+            "CreationTime": 1603911042.689,
+            "RequestCharacters": 1311,
+            "OutputFormat": "mp3",
+            "TextType": "text",
+            "VoiceId": "Joanna"
+        }
+    }
+
+For more information, see `Creating long audio files <https://docs.aws.amazon.com/polly/latest/dg/longer-cli.html>`__ in the *Amazon Polly Developer Guide*.

awscli/examples/polly/list-speech-synthesis-tasks.rst

@@ -1,25 +1,25 @@
-**To list your speech synthesis tasks**
-
-The following ``list-speech-synthesis-tasks`` example lists your speech synthesis tasks. ::
-
-    aws polly list-speech-synthesis-tasks 
-
-Output::
-
-    {
-        "SynthesisTasks": [
-            {
-                "TaskId": "70b61c0f-57ce-4715-a247-cae8729dcce9",
-                "TaskStatus": "completed",
-                "OutputUri": "https://s3.us-west-2.amazonaws.com/my-s3-bucket/70b61c0f-57ce-4715-a247-cae8729dcce9.mp3",
-                "CreationTime": 1603911042.689,
-                "RequestCharacters": 1311,
-                "OutputFormat": "mp3",
-                "TextType": "text",
-                "VoiceId": "Joanna"
-            }
-        ]
-    }
-
-For more information, see `Creating long audio files <https://docs.aws.amazon.com/polly/latest/dg/longer-cli.html>`__ in the *Amazon Polly Developer Guide*.
-
+**To list your speech synthesis tasks**
+
+The following ``list-speech-synthesis-tasks`` example lists your speech synthesis tasks. ::
+
+    aws polly list-speech-synthesis-tasks 
+
+Output::
+
+    {
+        "SynthesisTasks": [
+            {
+                "TaskId": "70b61c0f-57ce-4715-a247-cae8729dcce9",
+                "TaskStatus": "completed",
+                "OutputUri": "https://s3.us-west-2.amazonaws.com/amzn-s3-demo-bucket/70b61c0f-57ce-4715-a247-cae8729dcce9.mp3",
+                "CreationTime": 1603911042.689,
+                "RequestCharacters": 1311,
+                "OutputFormat": "mp3",
+                "TextType": "text",
+                "VoiceId": "Joanna"
+            }
+        ]
+    }
+
+For more information, see `Creating long audio files <https://docs.aws.amazon.com/polly/latest/dg/longer-cli.html>`__ in the *Amazon Polly Developer Guide*.
+

awscli/examples/polly/start-speech-synthesis-task.rst

@@ -1,27 +1,27 @@
-**To synthesize text**
-
-The following ``start-speech-synthesis-task`` example synthesizes the text in ``text_file.txt`` and stores the resulting MP3 file in the specified bucket. ::
-
-    aws polly start-speech-synthesis-task \
-        --output-format mp3 \
-        --output-s3-bucket-name my-s3-bucket \
-        --text  file://text_file.txt \
-        --voice-id Joanna
-
-Output::
-
-    {
-        "SynthesisTask": {
-            "TaskId": "70b61c0f-57ce-4715-a247-cae8729dcce9",
-            "TaskStatus": "scheduled",
-            "OutputUri": "https://s3.us-east-2.amazonaws.com/my-s3-bucket/70b61c0f-57ce-4715-a247-cae8729dcce9.mp3",
-            "CreationTime": 1603911042.689,
-            "RequestCharacters": 1311,
-            "OutputFormat": "mp3",
-            "TextType": "text",
-            "VoiceId": "Joanna"
-        }
-    }
-
-For more information, see `Creating long audio files <https://docs.aws.amazon.com/polly/latest/dg/longer-cli.html>`__ in the *Amazon Polly Developer Guide*.
-
+**To synthesize text**
+
+The following ``start-speech-synthesis-task`` example synthesizes the text in ``text_file.txt`` and stores the resulting MP3 file in the specified bucket. ::
+
+    aws polly start-speech-synthesis-task \
+        --output-format mp3 \
+        --output-s3-bucket-name amzn-s3-demo-bucket \
+        --text  file://text_file.txt \
+        --voice-id Joanna
+
+Output::
+
+    {
+        "SynthesisTask": {
+            "TaskId": "70b61c0f-57ce-4715-a247-cae8729dcce9",
+            "TaskStatus": "scheduled",
+            "OutputUri": "https://s3.us-east-2.amazonaws.com/amzn-s3-demo-bucket/70b61c0f-57ce-4715-a247-cae8729dcce9.mp3",
+            "CreationTime": 1603911042.689,
+            "RequestCharacters": 1311,
+            "OutputFormat": "mp3",
+            "TextType": "text",
+            "VoiceId": "Joanna"
+        }
+    }
+
+For more information, see `Creating long audio files <https://docs.aws.amazon.com/polly/latest/dg/longer-cli.html>`__ in the *Amazon Polly Developer Guide*.
+

awscli/examples/qldb/describe-journal-s3-export.rst

@@ -11,7 +11,7 @@ Output::
     {
         "ExportDescription": {
             "S3ExportConfiguration": {
-                "Bucket": "awsExampleBucket",
+                "Bucket": "amzn-s3-demo-bucket",
                 "Prefix": "ledgerexport1/",
                 "EncryptionConfiguration": {
                     "ObjectEncryptionType": "SSE_S3"

awscli/examples/qldb/export-journal-to-s3.rst

@@ -12,7 +12,7 @@ The following ``export-journal-to-s3`` example creates an export job for journal
 Contents of ``my-s3-export-config.json``::
 
     {
-        "Bucket": "awsExampleBucket",
+        "Bucket": "amzn-s3-demo-bucket",
         "Prefix": "ledgerexport1/",
         "EncryptionConfiguration": {
             "ObjectEncryptionType": "SSE_S3"

awscli/examples/qldb/list-journal-s3-exports-for-ledger.rst

@@ -14,7 +14,7 @@ Output::
                 "ExclusiveEndTime": 1568847599.0,
                 "ExportCreationTime": 1568847801.418,
                 "S3ExportConfiguration": {
-                    "Bucket": "awsExampleBucket",
+                    "Bucket": "amzn-s3-demo-bucket",
                     "Prefix": "ledgerexport1/",
                     "EncryptionConfiguration": {
                         "ObjectEncryptionType": "SSE_S3"

awscli/examples/qldb/list-journal-s3-exports.rst

@@ -15,7 +15,7 @@ Output::
                     "EncryptionConfiguration": {
                         "ObjectEncryptionType": "SSE_S3"
                     },
-                    "Bucket": "awsExampleBucket",
+                    "Bucket": "amzn-s3-demo-bucket",
                     "Prefix": "ledgerexport1/"
                 },
                 "RoleArn": "arn:aws:iam::123456789012:role/my-s3-export-role",
@@ -31,7 +31,7 @@ Output::
                     "EncryptionConfiguration": {
                         "ObjectEncryptionType": "SSE_S3"
                     },
-                    "Bucket": "awsExampleBucket",
+                    "Bucket": "amzn-s3-demo-bucket",
                     "Prefix": "ledgerexport1/"
                 },
                 "RoleArn": "arn:aws:iam::123456789012:role/my-s3-export-role",

awscli/examples/s3api/put-bucket-acl.rst

@@ -1,7 +1,7 @@
 This example grants ``full control`` to two AWS users (*user1@example.com* and *user2@example.com*) and ``read``
 permission to everyone::
 
-   aws s3api put-bucket-acl --bucket MyBucket --grant-full-control emailaddress=user1@example.com,emailaddress=user2@example.com --grant-read uri=http://acs.amazonaws.com/groups/global/AllUsers
+   aws s3api put-bucket-acl --bucket amzn-s3-demo-bucket --grant-full-control emailaddress=user1@example.com,emailaddress=user2@example.com --grant-read uri=http://acs.amazonaws.com/groups/global/AllUsers
 
 See http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTacl.html for details on custom ACLs (the s3api ACL
 commands, such as ``put-bucket-acl``, use the same shorthand argument notation).

awscli/examples/s3api/put-bucket-cors.rst

@@ -1,7 +1,7 @@
 The following example enables ``PUT``, ``POST``, and ``DELETE`` requests from *www.example.com*, and enables ``GET``
 requests from any domain::
 
-   aws s3api put-bucket-cors --bucket MyBucket --cors-configuration file://cors.json
+   aws s3api put-bucket-cors --bucket amzn-s3-demo-bucket --cors-configuration file://cors.json
 
    cors.json:
    {

awscli/examples/s3api/put-bucket-logging.rst

@@ -1,9 +1,9 @@
 **Example 1: To set bucket policy logging**
 
-The following ``put-bucket-logging`` example sets the logging policy for *MyBucket*. First, grant the logging service principal permission in your bucket policy using the ``put-bucket-policy`` command. ::
+The following ``put-bucket-logging`` example sets the logging policy for *amzn-s3-demo-bucket*. First, grant the logging service principal permission in your bucket policy using the ``put-bucket-policy`` command. ::
 
     aws s3api put-bucket-policy \
-        --bucket MyBucket \
+        --bucket amzn-s3-demo-bucket \
         --policy file://policy.json
 
 Contents of ``policy.json``::
@@ -16,7 +16,7 @@ Contents of ``policy.json``::
                 "Effect": "Allow",
                 "Principal": {"Service": "logging.s3.amazonaws.com"},
                 "Action": "s3:PutObject",
-                "Resource": "arn:aws:s3:::MyBucket/Logs/*",
+                "Resource": "arn:aws:s3:::amzn-s3-demo-bucket/Logs/*",
                 "Condition": {
                     "ArnLike": {"aws:SourceARN": "arn:aws:s3:::SOURCE-BUCKET-NAME"},
                     "StringEquals": {"aws:SourceAccount": "SOURCE-AWS-ACCOUNT-ID"}
@@ -28,14 +28,14 @@ Contents of ``policy.json``::
 To apply the logging policy, use ``put-bucket-logging``. ::
 
     aws s3api put-bucket-logging \
-        --bucket MyBucket \
+        --bucket amzn-s3-demo-bucket \
         --bucket-logging-status file://logging.json
 
 Contents of ``logging.json``::
 
    {
         "LoggingEnabled": {
-            "TargetBucket": "MyBucket",
+            "TargetBucket": "amzn-s3-demo-bucket",
             "TargetPrefix": "Logs/"
         }
     }
@@ -46,26 +46,26 @@ For more information, see `Amazon S3 Server Access Logging <https://docs.aws.ama
 
 **Example 2: To set a bucket policy for logging access to only a single user**
 
-The following ``put-bucket-logging`` example sets the logging policy for *MyBucket*. The AWS user *bob@example.com* will have full control over
+The following ``put-bucket-logging`` example sets the logging policy for *amzn-s3-demo-bucket*. The AWS user *bob@example.com* will have full control over
 the log files, and no one else has any access. First, grant S3 permission with ``put-bucket-acl``. ::
 
     aws s3api put-bucket-acl \
-        --bucket MyBucket \
+        --bucket amzn-s3-demo-bucket \
         --grant-write URI=http://acs.amazonaws.com/groups/s3/LogDelivery \
         --grant-read-acp URI=http://acs.amazonaws.com/groups/s3/LogDelivery
 
 Then apply the logging policy using ``put-bucket-logging``. ::
 
     aws s3api put-bucket-logging \
-        --bucket MyBucket \
+        --bucket amzn-s3-demo-bucket \
         --bucket-logging-status file://logging.json
 
 Contents of ``logging.json``::
 
     {
         "LoggingEnabled": {
-            "TargetBucket": "MyBucket",
-            "TargetPrefix": "MyBucketLogs/",
+            "TargetBucket": "amzn-s3-demo-bucket",
+            "TargetPrefix": "amzn-s3-demo-bucket-logs/",
             "TargetGrants": [
                 {
                     "Grantee": {

awscli/examples/s3api/put-bucket-policy.rst

@@ -1,7 +1,7 @@
-This example allows all users to retrieve any object in *MyBucket* except those in the *MySecretFolder*. It also
+This example allows all users to retrieve any object in *amzn-s3-demo-bucket* except those in the *MySecretFolder*. It also
 grants ``put`` and ``delete`` permission to the root user of the AWS account ``1234-5678-9012``::
 
-   aws s3api put-bucket-policy --bucket MyBucket --policy file://policy.json
+   aws s3api put-bucket-policy --bucket amzn-s3-demo-bucket --policy file://policy.json
 
    policy.json:
    {
@@ -10,13 +10,13 @@ grants ``put`` and ``delete`` permission to the root user of the AWS account ``1
             "Effect": "Allow",
             "Principal": "*",
             "Action": "s3:GetObject",
-            "Resource": "arn:aws:s3:::MyBucket/*"
+            "Resource": "arn:aws:s3:::amzn-s3-demo-bucket/*"
          },
          {
             "Effect": "Deny",
             "Principal": "*",
             "Action": "s3:GetObject",
-            "Resource": "arn:aws:s3:::MyBucket/MySecretFolder/*"
+            "Resource": "arn:aws:s3:::amzn-s3-demo-bucket/MySecretFolder/*"
          },
          {
             "Effect": "Allow",
@@ -27,7 +27,7 @@ grants ``put`` and ``delete`` permission to the root user of the AWS account ``1
                "s3:DeleteObject",
                "s3:PutObject"
             ],
-            "Resource": "arn:aws:s3:::MyBucket/*"
+            "Resource": "arn:aws:s3:::amzn-s3-demo-bucket/*"
          }
       ]
    }

awscli/examples/s3api/put-object-acl.rst

@@ -1,7 +1,7 @@
 The following command grants ``full control`` to two AWS users (*user1@example.com* and *user2@example.com*) and ``read``
 permission to everyone::
 
-   aws s3api put-object-acl --bucket MyBucket --key file.txt --grant-full-control emailaddress=user1@example.com,emailaddress=user2@example.com --grant-read uri=http://acs.amazonaws.com/groups/global/AllUsers
+   aws s3api put-object-acl --bucket amzn-s3-demo-bucket --key file.txt --grant-full-control emailaddress=user1@example.com,emailaddress=user2@example.com --grant-read uri=http://acs.amazonaws.com/groups/global/AllUsers
 
 See http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTacl.html for details on custom ACLs (the s3api ACL
 commands, such as ``put-object-acl``, use the same shorthand argument notation).

awscli/examples/synthetics/associate-resource.rst

@@ -0,0 +1,11 @@
+**To associate a canary with a group**
+
+The following ``associate-resource`` example associates a canary with a group named ``demo_group``. ::
+
+    aws synthetics associate-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/create-canary.rst

@@ -0,0 +1,48 @@
+**To create a canary**
+
+The following ``create-canary`` example creates a canary named ``demo_canary``. ::
+
+    aws synthetics create-canary \
+        --name demo_canary \
+        --code '{"S3Bucket": "artifacts3bucket", "S3Key":"demo_canary.zip", "Handler": "index.lambda_handler"}' \
+        --artifact-s3-location s3://amzn-s3-demo-bucket/demo_canary.zip \
+        --execution-role-arn arn:aws:iam::123456789012:role/demo_canary_role \
+        --schedule Expression="rate(10 minutes)" \
+        --runtime-version syn-nodejs-puppeteer-9.1
+
+Output::
+
+    {
+        "Canary": {
+            "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
+            "Name": "demo_canary",
+            "Code": {
+                "Handler": "index.lambda_handler"
+            },
+            "ExecutionRoleArn": "arn:aws:iam::123456789012:role/demo_canary_role",
+            "Schedule": {
+                "Expression": "rate(10 minutes)",
+                "DurationInSeconds": 0
+            },
+            "RunConfig": {
+                "TimeoutInSeconds": 600,
+                "MemoryInMB": 1000,
+                "ActiveTracing": false
+            },
+            "SuccessRetentionPeriodInDays": 31,
+            "FailureRetentionPeriodInDays": 31,
+            "Status": {
+                "State": "CREATING",
+                "StateReasonCode": "CREATE_PENDING"
+            },
+            "Timeline": {
+                "Created": "2024-10-15T19:03:08.826000+05:30",
+                "LastModified": "2024-10-15T19:03:08.826000+05:30"
+            },
+            "ArtifactS3Location": "amzn-s3-demo-bucket/demo_canary.zip",
+            "RuntimeVersion": "syn-nodejs-puppeteer-9.1",
+            "Tags": {}
+        }
+    }
+
+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/create-group.rst

@@ -0,0 +1,21 @@
+**To create a group**
+
+The following ``create-group`` example creates a group named ``demo_group``. ::
+
+    aws synthetics create-group \
+        --name 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/delete-canary.rst

@@ -0,0 +1,10 @@
+**To permanently delete a canary**
+
+The following ``delete-canary`` example deletes a canary named ``demo_canary``. ::
+
+    aws synthetics delete-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/delete-group.rst

@@ -0,0 +1,10 @@
+**To delete a group**
+
+The following ``delete-group`` example deletes a group named ``demo_group``. ::
+
+    aws synthetics delete-group \
+        --group-identifier demo_group
+
+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/describe-canaries-last-run.rst

@@ -0,0 +1,31 @@
+**To see information from the most recent run of each canary**
+
+The following ``describe-canaries-last-run`` example returns the most recent run of each canary that you have created. ::
+
+    aws synthetics describe-canaries-last-run
+
+Output::
+
+    {
+        "CanariesLastRun": [
+            {
+                "CanaryName": "demo_canary",
+                "LastRun": {
+                    "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
+                    "Name": "demo_canary",
+                    "Status": {
+                        "State": "PASSED",
+                        "StateReason": "",
+                        "StateReasonCode": ""
+                    },
+                    "Timeline": {
+                        "Started": "2024-10-15T19:20:39.691000+05:30",
+                        "Completed": "2024-10-15T19:20:58.211000+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*.