|
31 | 31 | }, |
32 | 32 | { |
33 | 33 | "shape": "ValidationException" |
| 34 | + }, |
| 35 | + { |
| 36 | + "shape": "RequestEntityTooLargeException" |
34 | 37 | } |
35 | 38 | ], |
36 | 39 | "documentation": "<p>Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. You can set up a canary to run continuously or just once. </p> <p>Do not use <code>CreateCanary</code> to modify an existing canary. Use <a href=\"https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_UpdateCanary.html\">UpdateCanary</a> instead.</p> <p>To create canaries, you must have the <code>CloudWatchSyntheticsFullAccess</code> policy. If you are creating a new IAM role for the canary, you also need the the <code>iam:CreateRole</code>, <code>iam:CreatePolicy</code> and <code>iam:AttachRolePolicy</code> permissions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Roles\">Necessary Roles and Permissions</a>.</p> <p>Do not include secrets or proprietary information in your canary names. The canary name makes up part of the Amazon Resource Name (ARN) for the canary, and the ARN is included in outbound calls over the internet. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html\">Security Considerations for Synthetics Canaries</a>.</p>" |
|
83 | 86 | "shape": "ValidationException" |
84 | 87 | } |
85 | 88 | ], |
86 | | - "documentation": "<p>This operation returns a list of the canaries in your account, along with full details about each canary.</p> <p>This operation does not have resource-level authorization, so if a user is able to use <code>DescribeCanaries</code>, the user can see all of the canaries in the account. A deny policy can only be used to restrict access to all canaries. It cannot be used on specific resources. </p>" |
| 89 | + "documentation": "<p>This operation returns a list of the canaries in your account, along with full details about each canary.</p> <p>This operation supports resource-level authorization using an IAM policy and the <code>Names</code> parameter. If you specify the <code>Names</code> parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.</p> <p>You are required to use the <code>Names</code> parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html\"> Limiting a user to viewing specific canaries</a>.</p>" |
87 | 90 | }, |
88 | 91 | "DescribeCanariesLastRun": { |
89 | 92 | "name": "DescribeCanariesLastRun", |
|
105 | 108 | "shape": "ValidationException" |
106 | 109 | } |
107 | 110 | ], |
108 | | - "documentation": "<p>Use this operation to see information from the most recent run of each canary that you have created.</p>" |
| 111 | + "documentation": "<p>Use this operation to see information from the most recent run of each canary that you have created.</p> <p>This operation supports resource-level authorization using an IAM policy and the <code>Names</code> parameter. If you specify the <code>Names</code> parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.</p> <p>You are required to use the <code>Names</code> parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html\"> Limiting a user to viewing specific canaries</a>.</p>" |
109 | 112 | }, |
110 | 113 | "DescribeRuntimeVersions": { |
111 | 114 | "name": "DescribeRuntimeVersions", |
|
331 | 334 | }, |
332 | 335 | { |
333 | 336 | "shape": "ConflictException" |
| 337 | + }, |
| 338 | + { |
| 339 | + "shape": "RequestEntityTooLargeException" |
334 | 340 | } |
335 | 341 | ], |
336 | 342 | "documentation": "<p>Use this operation to change the settings of a canary that has already been created.</p> <p>You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use <a href=\"https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_TagResource.html\">TagResource</a>.</p>" |
|
506 | 512 | }, |
507 | 513 | "ZipFile": { |
508 | 514 | "shape": "Blob", |
509 | | - "documentation": "<p>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 256 Kb.</p>" |
| 515 | + "documentation": "<p>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.</p> <p>For large canary scripts, we recommend that you use an S3 location instead of inputting it directly with this parameter.</p>" |
510 | 516 | }, |
511 | 517 | "Handler": { |
512 | 518 | "shape": "String", |
|
847 | 853 | "type": "structure", |
848 | 854 | "members": {} |
849 | 855 | }, |
| 856 | + "DescribeCanariesLastRunNameFilter": { |
| 857 | + "type": "list", |
| 858 | + "member": { |
| 859 | + "shape": "CanaryName" |
| 860 | + }, |
| 861 | + "max": 5, |
| 862 | + "min": 1 |
| 863 | + }, |
850 | 864 | "DescribeCanariesLastRunRequest": { |
851 | 865 | "type": "structure", |
852 | 866 | "members": { |
|
857 | 871 | "MaxResults": { |
858 | 872 | "shape": "MaxSize100", |
859 | 873 | "documentation": "<p>Specify this parameter to limit how many runs are returned each time you use the <code>DescribeLastRun</code> operation. If you omit this parameter, the default of 100 is used.</p>" |
| 874 | + }, |
| 875 | + "Names": { |
| 876 | + "shape": "DescribeCanariesLastRunNameFilter", |
| 877 | + "documentation": "<p>Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.</p> <p>If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.</p> <p>You are required to use the <code>Names</code> parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html\"> Limiting a user to viewing specific canaries</a>.</p>" |
860 | 878 | } |
861 | 879 | } |
862 | 880 | }, |
|
873 | 891 | } |
874 | 892 | } |
875 | 893 | }, |
| 894 | + "DescribeCanariesNameFilter": { |
| 895 | + "type": "list", |
| 896 | + "member": { |
| 897 | + "shape": "CanaryName" |
| 898 | + }, |
| 899 | + "max": 5, |
| 900 | + "min": 1 |
| 901 | + }, |
876 | 902 | "DescribeCanariesRequest": { |
877 | 903 | "type": "structure", |
878 | 904 | "members": { |
|
883 | 909 | "MaxResults": { |
884 | 910 | "shape": "MaxCanaryResults", |
885 | 911 | "documentation": "<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>" |
| 912 | + }, |
| 913 | + "Names": { |
| 914 | + "shape": "DescribeCanariesNameFilter", |
| 915 | + "documentation": "<p>Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.</p> <p>If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.</p> <p>You are required to use this parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html\"> Limiting a user to viewing specific canaries</a>.</p>" |
886 | 916 | } |
887 | 917 | } |
888 | 918 | }, |
|
0 commit comments